diff mbox series

[net,2/4] Documentation: bonding: fix the doc of peer_notif_delay

Message ID 20230420082230.2968883-3-liuhangbin@gmail.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series bonding: fix send_peer_notif overflow | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit fail Errors and warnings before: 22 this patch: 22
netdev/cc_maintainers warning 3 maintainers not CCed: corbet@lwn.net linux-doc@vger.kernel.org andy@greyhouse.net
netdev/build_clang success Errors and warnings before: 18 this patch: 18
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 18 this patch: 18
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 13 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Hangbin Liu April 20, 2023, 8:22 a.m. UTC
Bonding only supports setting peer_notif_delay with miimon set.

Fixes: 0307d589c4d6 ("bonding: add documentation for peer_notif_delay")
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
---
 Documentation/networking/bonding.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

Comments

Jay Vosburgh April 20, 2023, 3:52 p.m. UTC | #1
Hangbin Liu <liuhangbin@gmail.com> wrote:

>Bonding only supports setting peer_notif_delay with miimon set.
>
>Fixes: 0307d589c4d6 ("bonding: add documentation for peer_notif_delay")
>Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
>---
> Documentation/networking/bonding.rst | 7 +++----
> 1 file changed, 3 insertions(+), 4 deletions(-)
>
>diff --git a/Documentation/networking/bonding.rst b/Documentation/networking/bonding.rst
>index adc4bf4f3c50..6daeb18911fb 100644
>--- a/Documentation/networking/bonding.rst
>+++ b/Documentation/networking/bonding.rst
>@@ -776,10 +776,9 @@ peer_notif_delay
> 	Specify the delay, in milliseconds, between each peer
> 	notification (gratuitous ARP and unsolicited IPv6 Neighbor
> 	Advertisement) when they are issued after a failover event.
>-	This delay should be a multiple of the link monitor interval
>-	(arp_interval or miimon, whichever is active). The default
>-	value is 0 which means to match the value of the link monitor
>-	interval.
>+	This delay should be a multiple of the MII link monitor interval
>+	(miimon). The default value is 0 which means to match the value
>+        of the MII link monitor interval.

	Perhaps something like the following better reflects what we're
trying to convey here?

	This delay is rounded down to the MII link monitor interval
	(miimon), and cannot be set if miimon is not set.  The default
	value is 0 which provides no delay beyond the miimon interval.

	-J

> prio
> 	Slave priority. A higher number means higher priority.
>-- 
>2.38.1
>

---
	-Jay Vosburgh, jay.vosburgh@canonical.com
diff mbox series

Patch

diff --git a/Documentation/networking/bonding.rst b/Documentation/networking/bonding.rst
index adc4bf4f3c50..6daeb18911fb 100644
--- a/Documentation/networking/bonding.rst
+++ b/Documentation/networking/bonding.rst
@@ -776,10 +776,9 @@  peer_notif_delay
 	Specify the delay, in milliseconds, between each peer
 	notification (gratuitous ARP and unsolicited IPv6 Neighbor
 	Advertisement) when they are issued after a failover event.
-	This delay should be a multiple of the link monitor interval
-	(arp_interval or miimon, whichever is active). The default
-	value is 0 which means to match the value of the link monitor
-	interval.
+	This delay should be a multiple of the MII link monitor interval
+	(miimon). The default value is 0 which means to match the value
+        of the MII link monitor interval.
 
 prio
 	Slave priority. A higher number means higher priority.