Page MenuHomeFreeBSD
Differential D8136 Diff 20988 head/usr.sbin/arp/arp.4

Changeset View

Standalone View

View Options

head/usr.sbin/arp/arp.4

Show All 22 Lines
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" @(#)arp4.4 6.5 (Berkeley) 4/18/94 .\" @(#)arp4.4 6.5 (Berkeley) 4/18/94
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd November 5, 2013 .Dd October 3, 2016
.Dt ARP 4 .Dt ARP 4
.Os .Os
.Sh NAME .Sh NAME
.Nm arp .Nm arp
.Nd Address Resolution Protocol .Nd Address Resolution Protocol
.Sh SYNOPSIS .Sh SYNOPSIS
.Cd "device ether" .Cd "device ether"
.Sh DESCRIPTION .Sh DESCRIPTION
▲ Show 20 Lines • Show All 81 Lines • ▼ Show 20 Lines
MIB. MIB.
.Bl -tag -width "log_arp_permanent_modify" .Bl -tag -width "log_arp_permanent_modify"
.It Va allow_multicast .It Va allow_multicast
Should the kernel install ARP entries with multicast bit set in Should the kernel install ARP entries with multicast bit set in
the hardware address. the hardware address.
Installing such entries is RFC 1812 violation, but some prorietary Installing such entries is RFC 1812 violation, but some prorietary
load balancing techniques require routers on network to do so. load balancing techniques require routers on network to do so.
Turned off by default. Turned off by default.
.It Va garp_rexmit_count
Should the kernel retransmit gratuitous ARP (GARP) packets when an IPv4 address
wblockUnsubmitted
Not Done
Inline Actions

I suspect this is an ambiguous wording even for native English speakers, the leading "should" makes it sound like a question. How about:
Whether the kernel should

wblock: I suspect this is an ambiguous wording even for native English speakers, the leading "should"…
dabAuthorUnsubmitted
Not Done
Inline Actions

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?

dab: As you later noted, this phrasing is used in the existing descriptions, so I attempted to match…
vangyzenUnsubmitted
Not Done
Inline Actions

If you modify this one, please make them all consistent.

Removing everything before "retransmit" would be clear and succinct.

vangyzen: If you modify this one, please make them all consistent. Removing everything before…
wblockUnsubmitted
Not Done
Inline Actions

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.

wblock: My preference would be to fix them all, but I didn't mean to expand this with mission creep.
vangyzenUnsubmitted
Not Done
Inline Actions

I told him the same thing offline. :)

vangyzen: I told him the same thing offline. :)
is added to an interface.
A GARP is always transmitted when an IPv4 address is added to an interface.
A non-zero value of this sysctl will cause the GARP packet to be retransmitted
the stated number of times.
The interval between retransmissions is doubled each time, so the
retransmission intervals are: {1, 2, 4, 8, 16, ...} (seconds).
The default value of zero means only the initial GARP is sent; no
additional GARP packets are retransmitted.
The maximum value is sixteen.
.Pp
Although a single GARP packet (the default behavior) is usually sufficient, in
wblockUnsubmitted
Not Done
Inline Actions

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".)

wblock: The "although" kind of fights with the later parts of the sentence, and the whole sentence is…
dabAuthorUnsubmitted
Not Done
Inline Actions

Good suggestion, although my inner grammarian prefers "such as" to "like".

dab: Good suggestion, although my inner grammarian prefers "such as" to "like".
vangyzenUnsubmitted
Not Done
Inline Actions

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.

vangyzen: I like @wblock's suggestion, too. Now that I'm reading it again, however, the meaning is…
wblockUnsubmitted
Not Done
Inline Actions

"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.
wblock: "such as when" sounds more wrong than "like when" to me, but that might be a regional thing.
vangyzenUnsubmitted
Not Done
Inline Actions

Nice wording, @wblock.

vangyzen: Nice wording, @wblock.
some circumstances, such as when a shared address is passed between cluster
nodes, this single GARP may be dropped or lost.
This can lead to neighbors on the network link working with a stale ARP cache
and sending packets destined for that address to the node that previously owned
the address, which may not respond.
wblockUnsubmitted
Not Done
Inline Actions

As above, s/may/might/.

wblock: As above, s/may/might/.
.It Va log_arp_movements .It Va log_arp_movements
Should the kernel log movements of IP addresses from one hardware Should the kernel log movements of IP addresses from one hardware
wblockUnsubmitted
Not Done
Inline Actions

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.

wblock: Ah, these were in the original. They still are not good for clarity, but makes it clearer why…
address to an other. address to an other.
wblockUnsubmitted
Not Done
Inline Actions

This is a typo (not yours, just pointing it out): s/an other/another/.

wblock: This is a typo (not yours, just pointing it out): s/an other/another/.
See See
.Sx DIAGNOSTICS .Sx DIAGNOSTICS
below. below.
Turned on by default. Turned on by default.
.It Va log_arp_permanent_modify .It Va log_arp_permanent_modify
Should the kernel log attempts of remote host on network to modify a Should the kernel log attempts of remote host on network to modify a
permanent ARP entry. permanent ARP entry.
See See
▲ Show 20 Lines • Show All 96 Lines • Show Last 20 Lines