From: Jacob Keller <jacob.e.keller@intel.com>
To: Abdelrahman Fekry <abdelrahmanfekry375@gmail.com>,
<davem@davemloft.net>, <edumazet@google.com>, <kuba@kernel.org>,
<pabeni@redhat.com>, <horms@kernel.org>, <corbet@lwn.net>
Cc: <netdev@vger.kernel.org>, <linux-doc@vger.kernel.org>,
<linux-kernel@vger.kernel.org>, <skhan@linuxfoundation.com>,
<linux-kernel-mentees@lists.linux.dev>
Subject: Re: [PATCH 1/2] docs: net: sysctl documentation cleanup
Date: Thu, 12 Jun 2025 10:18:48 -0700 [thread overview]
Message-ID: <ede97506-e6ce-4af0-8c2f-19cd1987ec97@intel.com> (raw)
In-Reply-To: <20250612162954.55843-2-abdelrahmanfekry375@gmail.com>
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@gmail.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@intel.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?
next prev parent reply other threads:[~2025-06-12 17:19 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-12 16:29 [PATCH 0/2] docs: net: sysctl documentation improvements Abdelrahman Fekry
2025-06-12 16:29 ` [PATCH 1/2] docs: net: sysctl documentation cleanup Abdelrahman Fekry
2025-06-12 17:18 ` Jacob Keller [this message]
2025-06-13 6:07 ` ALOK TIWARI
2025-06-14 9:25 ` [PATCH v2 " Abdelrahman Fekry
2025-06-14 17:46 ` Jakub Kicinski
2025-06-12 16:29 ` [PATCH 2/2] docs: net: clarify sysctl value constraints Abdelrahman Fekry
2025-06-12 17:19 ` Jacob Keller
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ede97506-e6ce-4af0-8c2f-19cd1987ec97@intel.com \
--to=jacob.e.keller@intel.com \
--cc=abdelrahmanfekry375@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=skhan@linuxfoundation.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.