Subject: Re: [PATCH 3/3] ip: sysctl documentation cleanup

From: Stephen Hemminger <[email-masked]>
Date: Tue, 1 Jul 2008 16:13:57 -0700

On Tue, 1 Jul 2008 15:55:05 -0700 (PDT)
"Randy.Dunlap" <[email-masked]> wrote:

> 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 <[email-masked]>
> > 
> > --- 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 accept either as definitive norm on spelling, but looking at Webster
online, either spelling is now acceptable.  My spellchecker and old dictionary
appear out of date.