Re: [PATCH 1/2] docs: net: sysctl documentation cleanup
From: Jacob Keller <jacob.e.keller@intel.com>
Date: 2025-06-12 17:19:06
Also in:
linux-doc, linux-kernel-mentees, lkml
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 <redacted> ---
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@intel.com>
quoted hunk ↗ jump to hunk
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?