linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: ALOK TIWARI <alok.a.tiwari@oracle.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: Fri, 13 Jun 2025 11:37:16 +0530	[thread overview]
Message-ID: <1c39a436-438d-455a-a926-860d00d8f85f@oracle.com> (raw)
In-Reply-To: <20250612162954.55843-2-abdelrahmanfekry375@gmail.com>



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@gmail.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


  parent reply	other threads:[~2025-06-13  6:07 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
2025-06-13  6:07   ` ALOK TIWARI [this message]
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=1c39a436-438d-455a-a926-860d00d8f85f@oracle.com \
    --to=alok.a.tiwari@oracle.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).