linux-kernel - Re: [PATCH 1/2] docs: net: sysctl documentation cleanup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <1c39a436-438d-455a-a926-860d00d8f85f@oracle.com>
Date: Fri, 13 Jun 2025 11:37:16 +0530
From: ALOK TIWARI <alok.a.tiwari@...cle.com>
To: Abdelrahman Fekry <abdelrahmanfekry375@...il.com>, davem@...emloft.net,
        edumazet@...gle.com, kuba@...nel.org, pabeni@...hat.com,
        horms@...nel.org, corbet@....net
Cc: netdev@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, skhan@...uxfoundation.com,
        linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH 1/2] docs: net: sysctl documentation cleanup



On 12-06-2025 21:59, Abdelrahman Fekry wrote:
> I noticed that some boolean parameters have missing default values
> (enabled/disabled) in the documentation so i checked the initialization
> functions to get their default values, also there was some inconsistency
> in the representation. During the process , i stumbled upon a typo in
> cipso_rbm_struct_valid instead of cipso_rbm_struct_valid.
> 
> - Fixed typo in cipso_rbm_struct_valid
> - Added missing default value declarations
> - Standardized boolean representation (0/1 with enabled/disabled)
> 
> Signed-off-by: Abdelrahman Fekry <abdelrahmanfekry375@...il.com>
> ---
>   Documentation/networking/ip-sysctl.rst | 37 +++++++++++++++++++++-----
>   1 file changed, 31 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
> index 0f1251cce314..f7ff8c53f412 100644
> --- a/Documentation/networking/ip-sysctl.rst
> +++ b/Documentation/networking/ip-sysctl.rst
> @@ -75,7 +75,7 @@ fwmark_reflect - BOOLEAN
>   	If unset, these packets have a fwmark of zero. If set, they have the
>   	fwmark of the packet they are replying to.
>   
> -	Default: 0
> +	Default: 0 (disabled)
>   
>   fib_multipath_use_neigh - BOOLEAN
>   	Use status of existing neighbor entry when determining nexthop for
> @@ -368,7 +368,7 @@ tcp_autocorking - BOOLEAN
>   	queue. Applications can still use TCP_CORK for optimal behavior
>   	when they know how/when to uncork their sockets.
>   
> -	Default : 1
> +	Default : 1 (enabled)

for consistency
remove extra space before colon
Default: 1 (enabled)

>   
>   tcp_available_congestion_control - STRING
>   	Shows the available congestion control choices that are registered.
> @@ -407,6 +407,12 @@ tcp_congestion_control - STRING
>   
>   tcp_dsack - BOOLEAN
>   	Allows TCP to send "duplicate" SACKs.
> +	Possible values:
> +		- 0 disabled
> +		- 1 enabled
> +
> +	Default: 1 (enabled)
>   
>   tcp_early_retrans - INTEGER
>   	Tail loss probe (TLP) converts RTOs occurring due to tail
> @@ -623,6 +629,8 @@ tcp_no_metrics_save - BOOLEAN
>   	increases overall performance, but may sometimes cause performance
>   	degradation.  If set, TCP will not cache metrics on closing
>   	connections.
> +
> +	Default: 0 (disabled)
>   
>   tcp_no_ssthresh_metrics_save - BOOLEAN
>   	Controls whether TCP saves ssthresh metrics in the route cache.
> @@ -684,6 +692,8 @@ tcp_retrans_collapse - BOOLEAN
>   	Bug-to-bug compatibility with some broken printers.
>   	On retransmit try to send bigger packets to work around bugs in
>   	certain TCP stacks.
> +
> +	Default: 1 (enabled)
>   
>   tcp_retries1 - INTEGER
>   	This value influences the time, after which TCP decides, that
> @@ -739,6 +749,8 @@ tcp_rmem - vector of 3 INTEGERs: min, default, max
>   
>   tcp_sack - BOOLEAN
>   	Enable select acknowledgments (SACKS).
> +
> +	Default: 1 (enabled)
>   
>   tcp_comp_sack_delay_ns - LONG INTEGER
>   	TCP tries to reduce number of SACK sent, using a timer
> @@ -766,7 +778,7 @@ tcp_backlog_ack_defer - BOOLEAN
>   	one ACK for the whole queue. This helps to avoid potential
>   	long latencies at end of a TCP socket syscall.
>   
> -	Default : true
> +	Default : 1 (enabled)

Default: 1 (enabled)

>   
>   tcp_slow_start_after_idle - BOOLEAN
>   	If set, provide RFC2861 behavior and time out the congestion
> @@ -781,7 +793,7 @@ tcp_stdurg - BOOLEAN
>   	Most hosts use the older BSD interpretation, so if you turn this on
>   	Linux might not communicate correctly with them.


Thanks,
Alok