I wanted to use netlink, and after reading existing
userland code I found the snl(3) library.
However, there would be a considerable time savings
if netlink(4) included a reference to snl(3) so developers
could discover these libraries faster.
Also, I fixed some lint warning in these manuals.
Details
- Reviewers
bapt pauamma_gundo.com melifaro ziaee glebius - Group Reviewers
manpages - Commits
- rGadb66ef8c6ff: netlink(4): Add snl(3) to See Also section
mandoc -Tlint
Diff Detail
- Repository
- rG FreeBSD src repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
I'm all for making userland libraries easier to learn about.
Perhaps, to make it even easier in this case, you could add a mention of what snl(3) is good for, for example in the first paragraph of section "PROTOCOL DESCRIPTION". Something like:
In addition, wrapper library .Xr snl 3 can make parsing or assembling messages easier.
What do you think?
Personally, I prefer a manual to stick strictly to its own contents and avoid referencing other libraries in the main text which keeps it concise and easier to read. for me it's easier to jump between manuals than within a single man page.
IMHO, the "See Also" section should be sufficient.
Personally, I prefer a manual to stick strictly to its own contents and avoid referencing other libraries in the main text which keeps it concise and easier to read
Yes please! The utility of manuals is extremely sensitive to any bloat.
for me it's easier to jump between manuals than within a single man page.
Only if you know they exist :)
In this case, since SEE ALSO is so contained, this works. What I don't want is multiple lines of SEE ALSO.