Submitted By: Marie Helene Kvello-Aune <marieheleneka@gmail.com>
PR: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=184110
Details
Details
- Reviewers
eadler wblock marieheleneka_gmail.com bcr - Group Reviewers
manpages - Commits
- rS287528: Document the sctp blackhole sysctl MIB
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 305 Build 305: arc lint + arc unit
Event Timeline
| share/man/man4/blackhole.4 | ||
|---|---|---|
| 27 | The notation looks wrong. Can .Op be used? | |
| 57 | Start new sentences on new lines. | |
| 58 | Start new sentences on new lines. | |
| 59 | "out of the blue" is colloquial. Better to say "unexpected packets are received", or some other more descriptive term. | |
| sys/netinet/sctp_sysctl.h | ||
| 548 | "man page" is redundant. "for more details" probably is also. | |
| share/man/man4/blackhole.4 | ||
|---|---|---|
| 25 | For .Op, I meant more like this: .Cd sysctl net.inet.sctp.blackhole Ns Op = Ns Brq "0 | 1" I can't find any other examples of parameters like that. The curly bracket usage here is the same as used in mdoc(7). It probably isn't any worse than the original. Better, probably, because the original implied that the numbers after the = are optional (they aren't). | |
| share/man/man4/blackhole.4 | ||
|---|---|---|
| 25 | I think that might have been on purpose. The numbers in fact are optional, in the case where you want to read the value, and see what it is set to, instead of setting it. | |
| share/man/man4/blackhole.4 | ||
|---|---|---|
| 25 | The way it was shown implied that the numbers were optional even with the = specified. On 10-STABLE at least, that is not the case: % sysctl net.inet.tcp.blackhole= sysctl: empty numeric value | |
Comment Actions
Improved formatting of synopsis according to wblock's feedback.
Added subsections to the DESCRIPTION section for SCTP, TCP, and UDP
Moved the SCTP subsection to the top, so that the subsections are sorted alphabetically
Phrases which list SCTP, TCP, and UDP together are now consistent in listing them alphabetically
Moved the 'summary' paragraph from the bottom of DESCRIPTION to directly before the first subsection.
Comment Actions
The SCTP subsection felt awkward, so I've reworded it to flow better for the reader.
Updated the DESCRIPTION section according to wblock's feedback.