Add missing descriptions in sysctl net.inet6 namespace

[marieheleneka_gmail.com]

Summary

PR: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=205879

Add descriptions to most sysctl's in the net.inet6 namespace which doesn't already have one. I used the inet6(4) man page as source.

[wblock]

sys/netinet6/in6_proto.c

534

Default number of fragmented packets

535

s/setting/value/

536

s/setting/value/

560

Default maximum number of

574

Passive -> active:
s/Identifies/Identify/

"this nodes KAME" is actually a possessive:

this node's KAME

581

"IPv6 router renumbering prefix babysitting" is a lot of adjectives in a row. It's kind of hard to find the noun. Would reordering help clarify? "Default interval in seconds for prefix babysitting of IPv6 router renumbering."?

595

The "whether" wording is kind of confusing, but I'm not sure what would be clearer. "Determine whether" might be a little better.

Avoid contractions, and clear up a little confusion over who "they" refers to:

A value of 0 means sockets listen on both IPv6 and IPv4 addresses.

[emaste]

Thanks for this!

A couple of notes:

• descriptions conventionally do not include a period
• I think it makes sense to keep the descriptions similar to the IPv4 ones where they have the same meaning -- e.g. Enable IP forwarding between interfaces vs Enable routing/forwarding of IPv6 packets

[marieheleneka_gmail.com]

Updated revision addressing inline comments.
Moved Warren Block and Ed Maste from Subscribers to Reviewers.

[wblock]

sys/netinet6/in6_proto.c

595

Was the removal of the second sentence intentional? If not, I think this is better than the earlier version I suggested:

When 0, sockets listen on both IPv6 and IPv4 addresses.

[marieheleneka_gmail.com]

sys/netinet6/in6_proto.c

581

This is a tough one, but I think "Default interval in seconds for babysitting of IPv6 router prefix renumbering." should do the trick.

595

I'll drop the second sentence here, as it's implicated by the first sentence AND documented in the man page.

595

It was intentional, but I marked my comment about it as done. Doh.
Quoting: "I'll drop the second sentence here, as it's implicated by the first sentence AND documented in the man page."
s/implicated/implied :)

[wblock]

Works for me.

sys/netinet6/in6_proto.c

595

Phabricator conscientiously hid that comment from me, apparently. :)

[marieheleneka_gmail.com]

Please do not commit this yet. Out of a couple thousand sysctl's, only about 130 had a description ending with a period. Although I did not filter out the ones without a description, I still think this is telling.

Therefore, I'll remove the ending periods on these descriptions.

[marieheleneka_gmail.com]

sysctl MIB descriptions now end without punctuation, to be in line with how this is generally done. Also removed ending period of some existing descriptions.

[wblock]

sys/netinet6/in6_proto.c

526

When there is actually more there one complete sentence in a comment, adding a final ending period seems okay.

There might be a guideline on how these should be written. Maybe they are supposed to be expressed as a single short description. Or maybe we should create one.

This section could be rewritten as:

Enable sending ICMPv6 redirects for unforwardable IPv6 packets, ignored unless the node is routing IPv6

561

As above, this can just be

" incoming IPv6 packets, 0 for no artificial limit");

[emaste]

sys/netinet6/in6_proto.c

526

There might be a guideline on how these should be written. Maybe they are supposed to be expressed as a single short description. Or maybe we should create one.

I don't think it's written down anywhere, but probably should be. My impression is that they should be a single short description, and in fact the "ignored unless" may well be superfluous. Perhaps this could just be send ICMPv6 redirects for unforwardable IPv6 packets when routing IPv6

[wblock]

sys/netinet6/in6_proto.c

526

Nice!

[marieheleneka_gmail.com]

Simplified language as suggested by reviewers

[wblock]

Even better now.

[emaste]

looks good

[emaste]

rS299827