diff mbox series

[3/4] doc: networking: document arp_evict_nocarrier

Message ID 20211013222710.4162634-3-prestwoj@gmail.com (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series [1/4] net: arp: introduce arp_evict_nocarrier sysctl parameter | expand

Checks

Context Check Description
netdev/tree_selection success Guessing tree name failed - patch did not apply

Commit Message

James Prestwood Oct. 13, 2021, 10:27 p.m. UTC
Signed-off-by: James Prestwood <prestwoj@gmail.com>
---
 Documentation/networking/ip-sysctl.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

David Ahern Oct. 14, 2021, 6:34 p.m. UTC | #1
On 10/13/21 4:27 PM, James Prestwood wrote:
> Signed-off-by: James Prestwood <prestwoj@gmail.com>
> ---
>  Documentation/networking/ip-sysctl.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
> index c2ecc9894fd0..174d9d3ee5c2 100644
> --- a/Documentation/networking/ip-sysctl.rst
> +++ b/Documentation/networking/ip-sysctl.rst
> @@ -1565,6 +1565,15 @@ arp_accept - BOOLEAN
>  	gratuitous arp frame, the arp table will be updated regardless
>  	if this setting is on or off.
>  
> +arp_evict_nocarrier - BOOLEAN
> +	Clears the ARP cache on NOCARRIER events. This option is important for
> +	wireless devices where the ARP cache should not be cleared when roaming
> +	between access points on the same network. In most cases this should
> +	remain as the default (1).
> +
> +	- 1 - (default): Clear the ARP cache on NOCARRIER events
> +	- 0 - Do not clear ARP cache on NOCARRIER events
> +
>  mcast_solicit - INTEGER
>  	The maximum number of multicast probes in INCOMPLETE state,
>  	when the associated hardware address is unknown.  Defaults
> 

documentation can be added to the patch that adds the new sysctl
diff mbox series

Patch

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index c2ecc9894fd0..174d9d3ee5c2 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst
@@ -1565,6 +1565,15 @@  arp_accept - BOOLEAN
 	gratuitous arp frame, the arp table will be updated regardless
 	if this setting is on or off.
 
+arp_evict_nocarrier - BOOLEAN
+	Clears the ARP cache on NOCARRIER events. This option is important for
+	wireless devices where the ARP cache should not be cleared when roaming
+	between access points on the same network. In most cases this should
+	remain as the default (1).
+
+	- 1 - (default): Clear the ARP cache on NOCARRIER events
+	- 0 - Do not clear ARP cache on NOCARRIER events
+
 mcast_solicit - INTEGER
 	The maximum number of multicast probes in INCOMPLETE state,
 	when the associated hardware address is unknown.  Defaults