netdev - Re: [PATCH 3/3] ip: 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]

Date:	Tue, 1 Jul 2008 15:55:05 -0700 (PDT)
From:	"Randy.Dunlap" <rdunlap@...otime.net>
To:	Stephen Hemminger <shemminger@...tta.com>
cc:	David Miller <davem@...emloft.net>, netdev@...r.kernel.org
Subject: Re: [PATCH 3/3] ip: sysctl documentation cleanup

Hi Stephen,

On Tue, 1 Jul 2008, Stephen Hemminger wrote:

> Fix some documentation stuff:
>   * replace non-standard spelling
>   * remove confusing sentence in F-RTO description. The existing
>     text is sufficient to explain what the option does
>   * reorganize and update list of undocumented values
> 
> Signed-off-by: Stephen Hemminger <shemminger@...tta.com>
> 
> --- a/Documentation/networking/ip-sysctl.txt	2008-07-01 14:52:00.000000000 -0700
> +++ b/Documentation/networking/ip-sysctl.txt	2008-07-01 15:12:26.000000000 -0700
> @@ -159,7 +159,7 @@ tcp_congestion_control - STRING
>  	Default is set as part of kernel configuration.
>  
>  tcp_dsack - BOOLEAN
> -	Allows TCP to send "duplicate" SACKs.
> +	Allows TCP to send "duplicate" SACK's.

I think that either way is OK for these...

>  
>  tcp_ecn - BOOLEAN
>  	Enable Explicit Congestion Notification in TCP.
> @@ -185,10 +185,9 @@ tcp_frto - INTEGER
>  	timeouts.  It is particularly beneficial in wireless environments
>  	where packet loss is typically due to random radio interference
>  	rather than intermediate router congestion.  F-RTO is sender-side
> -	only modification.  Therefore it does not require any support from
> -	the peer, but in a typical case, however, where wireless link is
> -	the local access link and most of the data flows downlink, the
> -	faraway servers should have F-RTO enabled to take advantage of it.
> +	only modification therefore it does not require any support from
> +	the peer.

Run-on sentence :(

> +
>  	If set to 1, basic version is enabled.  2 enables SACK enhanced
>  	F-RTO if flow uses SACK.  The basic version can be used also when
>  	SACK is in use though scenario(s) with it exists where F-RTO
> @@ -270,13 +269,13 @@ tcp_mem - vector of 3 INTEGERs: min, pre
>  	pressure mode, which is exited when memory consumption falls
>  	under "min".
>  
> -	max: number of pages allowed for queueing by all TCP sockets.
> +	max: number of pages allowed for queuing by all TCP sockets.

google for "queuing theory" has about 198,000 hits.
google for "queueing theory" has about 499,000 hits.

grep kernel source tree for "queuing" has 487 hits.
grep kernel source tree for "queueing" has 728 hits.

I wouldn't change this.

>  
>  	Defaults are calculated at boot time from amount of available
>  	memory.
>  
>  tcp_moderate_rcvbuf - BOOLEAN
> -	If set, TCP performs receive buffer autotuning, attempting to
> +	If set, TCP performs receive buffer auto tuning, attempting to

or auto-tuning?  :)

>  	automatically size the buffer (no greater than tcp_rmem[2]) to
>  	match the size required by the path for full throughput.  Enabled by
>  	default.

-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html