Page MenuHomeFreeBSD

netlink(4): add snl(3) to See Also section
AcceptedPublic

Authored by p.mousavizadeh_protonmail.com on Mon, Nov 17, 12:21 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Nov 20, 6:00 PM
Unknown Object (File)
Thu, Nov 20, 5:59 PM
Unknown Object (File)
Thu, Nov 20, 5:50 PM
Unknown Object (File)
Tue, Nov 18, 11:46 AM
Unknown Object (File)
Tue, Nov 18, 6:49 AM
Unknown Object (File)
Tue, Nov 18, 5:29 AM
Unknown Object (File)
Tue, Nov 18, 2:28 AM
Unknown Object (File)
Mon, Nov 17, 11:41 PM
Subscribers

Details

Reviewers
bapt
pauamma_gundo.com
melifaro
Group Reviewers
manpages
Summary

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.

Test Plan

mandoc -Tlint

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 68684
Build 65567: arc lint + arc unit

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?

This revision is now accepted and ready to land.Tue, Nov 18, 10:41 PM

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.