Page MenuHomeFreeBSD

IfAPI: Update ifnet(9) man page
Needs ReviewPublic

Authored by jhibbits on Thu, Dec 5, 4:11 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Dec 15, 5:23 PM
Unknown Object (File)
Tue, Dec 10, 12:21 AM
Unknown Object (File)
Sun, Dec 8, 6:53 PM

Details

Reviewers
None
Group Reviewers
manpages
network
Summary

Extremely rough start of documenting the IfAPI.

Posting to solicit feedback on if this is the right way to do it, my man-fu
is... bad at best.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 61077
Build 57961: arc lint + arc unit

Event Timeline

emaste added inline comments.
share/man/man9/Makefile
1344

I wonder if we should mlink it or have a standalone ifapi(9) (as we do with iflib)? Not sure, but if we do decide to do so it could be a subsequent change.

share/man/man9/ifnet.9
104

blank lines are discouraged in man pages I believe, use .\" if spacing is desired for readability

This is cool! Just a few tiny nits from me. emaste is correct about the empty space, it actually produces two linter errors.

share/man/man9/ifnet.9
29

You wanna spell out the whole month in mdoc(7) or it produces a linter error. You can check the linter for errors with mandoc -Tlint share/man/man9/ifnet.9.

424–425

Not sure if this is correct, but there are a striking amount of parenthesis here, making it hard to understand.

434–435
439–441

Again, not sure that this meaning is correct, you may need to use a different word than "attaching" but lots of parenthesis is stressful for English.

444–451

Although, style.mdoc(5) says Dq Li is deprecated and suggests using Ql instead. Note that this renders as single quoted instead of double quoted.

465
478

You may need to use different word than "attaching", I do not understand the code, but full sentences inside parenthesis, particularly with punctuation, is kinda... a grammatical structure of last resort in American English.

492
517–518
527–528
532–533
538–540
544
546
557
jhibbits marked 16 inline comments as done.

Address feedback. Also ran mandoc -T lint over it, and fixed existing lint errors.

This is cool! Just a few tiny nits from me. emaste is correct about the empty space, it actually produces two linter errors.

Thanks for the review. Some of the nits you pointed out were preexisting, where I simply moved the text around, but I'm glad you pointed the issues out, so I can correct them to better fit with the function APIs rather than the preexisting structure.

I think I've fixed everything you pointed out.

Actually update the date...