Update the arp(4) man page to document the net.link.ether.inet.garp_rexmit_count sysctl.
Requested by: markj@
Details
Details
- Reviewers
markj vangyzen - Group Reviewers
manpages - Commits
- rS306652: Update arp(4) to document the net.link.ether.inet.garp_rexmit_count sysctl.
Ran igor and mandoc -Tlint; ran man and visually verified output.
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 5420 Build 5622: arc lint + arc unit
Event Timeline
| usr.sbin/arp/arp.4 | ||
|---|---|---|
| 141 | Seems like a space is missing between ')' and 'i'. | |
| head/usr.sbin/arp/arp.4 | ||
|---|---|---|
| 130 ↗ | (On Diff #20988) | I suspect this is an ambiguous wording even for native English speakers, the leading "should" makes it sound like a question. How about: |
| 141 ↗ | (On Diff #20988) | The "although" kind of fights with the later parts of the sentence, and the whole sentence is kind of long. How about: The default behavior of a single GARP packet is usually sufficient. However, in circumstances like when a shared address is passed between cluster nodes, this single GARP might be dropped or lost. (Note also the change from "may", usually implying "you are allowed", to "might", meaning "potentially".) |
| 146 ↗ | (On Diff #20988) | As above, s/may/might/. |
| 148 ↗ | (On Diff #20988) | Ah, these were in the original. They still are not good for clarity, but makes it clearer why the new sections were worded that way. |
| 149 ↗ | (On Diff #20988) | This is a typo (not yours, just pointing it out): s/an other/another/. |
| head/usr.sbin/arp/arp.4 | ||
|---|---|---|
| 130 ↗ | (On Diff #20988) | As you later noted, this phrasing is used in the existing descriptions, so I attempted to match it. I agree it is odd. Would you prefer I change this (new) description only, leave as-is, or modify all the descriptions to avoid the odd phrasing? |
| 141 ↗ | (On Diff #20988) | Good suggestion, although my inner grammarian prefers "such as" to "like". |
| head/usr.sbin/arp/arp.4 | ||
|---|---|---|
| 130 ↗ | (On Diff #20988) | If you modify this one, please make them all consistent. Removing everything before "retransmit" would be clear and succinct. |
| 141 ↗ | (On Diff #20988) | I like @wblock's suggestion, too. Now that I'm reading it again, however, the meaning is actually not quite right. The GARP can be dropped or lost in any case; it's just more harmful in the mentioned case. |
| head/usr.sbin/arp/arp.4 | ||
|---|---|---|
| 130 ↗ | (On Diff #20988) | My preference would be to fix them all, but I didn't mean to expand this with mission creep. If you want to do that, it's fine. If not, please let me know, and I will do it. |
| 141 ↗ | (On Diff #20988) | "such as when" sounds more wrong than "like when" to me, but that might be a regional thing. This might be best cleared up by splitting the two thoughts into two sentences. The first is that sometimes the GARP might be dropped or lost, the second is examples of a typical cause of that. Maybe @vangyzen's point can be worked into that: The default behavior of a single GARP packet is usually sufficient. However, a single GARP might be dropped or lost in some circumstances. This is particularly harmful when a shared address is being passed between cluster nodes. |