Page MenuHomeFreeBSD

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

Authored by pouria on Nov 17 2025, 12:21 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Jan 9, 7:14 PM
Unknown Object (File)
Sun, Dec 28, 4:32 PM
Unknown Object (File)
Fri, Dec 26, 7:20 PM
Unknown Object (File)
Dec 19 2025, 10:16 AM
Unknown Object (File)
Dec 11 2025, 9:06 PM
Unknown Object (File)
Dec 11 2025, 6:20 PM
Unknown Object (File)
Dec 10 2025, 12:48 AM
Unknown Object (File)
Nov 25 2025, 4:03 PM

Details

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 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?

This revision is now accepted and ready to land.Nov 18 2025, 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.

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.

This revision was automatically updated to reflect the committed changes.