diff mbox series

[iproute2,v2] bridge: make mcast_flood description consistent

Message ID 20190220163357.25968-1-vivien.didelot@gmail.com
State Accepted
Delegated to: stephen hemminger
Headers show
Series [iproute2,v2] bridge: make mcast_flood description consistent | expand

Commit Message

Vivien Didelot Feb. 20, 2019, 4:33 p.m. UTC 
This patch simply changes the description of the mcast_flood flag
with "flood" instead of "be flooded with" to avoid confusion, and be
consistent with the description of the flooding flag, which "Controls
whether a given port will *flood* unicast traffic for which there is
no FDB entry."

At the same time, fix the documentation for the "flood" flag which
is incorrectly described as "flooding on" or "flooding off".

Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>
---
 man/man8/bridge.8     | 4 ++--
 man/man8/ip-link.8.in | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

Comments

Stephen Hemminger Feb. 21, 2019, 10:48 p.m. UTC | #1 
On Wed, 20 Feb 2019 11:33:57 -0500
Vivien Didelot <vivien.didelot@gmail.com> wrote:

> This patch simply changes the description of the mcast_flood flag
> with "flood" instead of "be flooded with" to avoid confusion, and be
> consistent with the description of the flooding flag, which "Controls
> whether a given port will *flood* unicast traffic for which there is
> no FDB entry."
> 
> At the same time, fix the documentation for the "flood" flag which
> is incorrectly described as "flooding on" or "flooding off".
> 
> Signed-off-by: Vivien Didelot <vivien.didelot@gmail.com>

Applied
diff mbox series

Patch

diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
index 72210f62..13c46386 100644
--- a/man/man8/bridge.8
+++ b/man/man8/bridge.8
@@ -344,7 +344,7 @@  Controls whether a given port will sync MAC addresses learned on device port to
 bridge FDB.
 
 .TP
-.BR "flooding on " or " flooding off "
+.BR "flood on " or " flood off "
 Controls whether a given port will flood unicast traffic for which there is no FDB entry. By default this flag is on.
 
 .TP
@@ -361,7 +361,7 @@  switch.
 
 .TP
 .BR "mcast_flood on " or " mcast_flood off "
-Controls whether a given port will be flooded with multicast traffic for which there is no MDB entry. By default this flag is on.
+Controls whether a given port will flood multicast traffic for which there is no MDB entry. By default this flag is on.
 
 .TP
 .BR "neigh_suppress on " or " neigh_suppress off "
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index 5132f514..cef489a4 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -2155,7 +2155,7 @@  queries.
 option above.
 
 .BR mcast_flood " { " on " | " off " }"
-- controls whether a given port will be flooded with multicast traffic for which there is no MDB entry.
+- controls whether a given port will flood multicast traffic for which there is no MDB entry.
 
 .BI group_fwd_mask " MASK "
 - set the group forward mask. This is the bitmask that is applied to decide whether to forward incoming frames destined to link-local addresses, ie addresses of the form 01:80:C2:00:00:0X (defaults to 0, ie the bridge does not forward any link-local frames coming on this port).