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: <ede97506-e6ce-4af0-8c2f-19cd1987ec97@intel.com>
Date: Thu, 12 Jun 2025 10:18:48 -0700
From: Jacob Keller <jacob.e.keller@...el.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 6/12/2025 9:29 AM, 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>
> ---

Thank you for the documentation improvements! I do think its a bit more
clear to include the "(enabled)" or "(disabled)".

Reviewed-by: Jacob Keller <jacob.e.keller@...el.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
> @@ -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)
>  

Would it make sense to use "0 (disabled)" and "1 (enabled)" with
parenthesis for consistency with the default value?