[Cvs-cvs] ccvs/doc ChangeLog cvs.1 cvs.texinfo

[Derek Robert Price]

CVSROOT:        /cvsroot/cvs
Module name:    ccvs
Branch:         
Changes by:     Derek Robert Price <address@hidden>     06/04/05 14:19:28

Modified files:
        doc            : ChangeLog cvs.1 cvs.texinfo 

Log message:
        * cvs.texinfo (Global options): Allow for units.  Provide suggested
        minimum value for servers.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/cvs/ccvs/doc/ChangeLog.diff?tr1=1.951&tr2=1.952&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/cvs/ccvs/doc/cvs.1.diff?tr1=1.41&tr2=1.42&r1=text&r2=text
http://cvs.savannah.gnu.org/viewcvs/cvs/ccvs/doc/cvs.texinfo.diff?tr1=1.678&tr2=1.679&r1=text&r2=text

Patches:
Index: ccvs/doc/ChangeLog
diff -u ccvs/doc/ChangeLog:1.951 ccvs/doc/ChangeLog:1.952
--- ccvs/doc/ChangeLog:1.951    Wed Apr  5 13:48:36 2006
+++ ccvs/doc/ChangeLog  Wed Apr  5 14:19:27 2006
@@ -1,5 +1,8 @@
 2006-04-05  Derek Price  <address@hidden>
 
+       * cvs.texinfo (Global options): Allow for units.  Provide suggested
+       minimum value for servers.
+
        * cvs.texinfo: Fix typos.
        (From wiki.)
 
Index: ccvs/doc/cvs.1
diff -u ccvs/doc/cvs.1:1.41 ccvs/doc/cvs.1:1.42
--- ccvs/doc/cvs.1:1.41 Tue Mar 28 15:30:49 2006
+++ ccvs/doc/cvs.1      Wed Apr  5 14:19:28 2006
@@ -406,18 +406,31 @@
 .IX "Timeout, network connections"
 .IX "--timeout, global command line option"
 .IP "" 0
-\fB--timeout \fIseconds\fB\fR
+\fB--timeout \fIwaitfor\fB\fR
 .IP "" 2
 Time out network connections when no data is accepted by or received from the
-peer for \fIseconds\fR seconds.  It is recommended that \fBcvs\fR clients do 
not
-set this value to less than 31 seconds for read operations or to a value
-much less than 40 seconds for commits since \fBcvs\fR servers can pause
-legitimately for just over 30 seconds while waiting to obtain a lock and can
-pause for an additional amount of time dependent on server load and the size of
-a commit when the user is attempting a commit.  A value of zero for
-\fIseconds\fR means to wait on the network indefinitely (or until the
+peer for the amount of time specified in \fIwaitfor\fR.  \fBd\fR, \fBh\fR,
+\fBm\fR, and \fBs\fR (days, hours, minutes, and seconds, respectively) are
+acceptable units when found at the end of \fIwaitfor\fR (for example,
+\fB1d\fR, \fB3h\fR, and \fB40s\fR are all acceptable values for
+\fIwaitfor\fR).  If no units are supplied, seconds are assumed.  A value of
+zero for \fIwaitfor\fR means to wait on the network indefinitely (or until the
 connection is determined to be broken by other means, but this isn\(aqt always
-detectable on some systems).  \fIseconds\fR defaults to zero.
+detectable on some systems).  \fIwaitfor\fR defaults to zero.
+.SP
+\fBIt is recommended that \fBcvs\fB clients do not set this value to less
+than 31 seconds for read operations or to a value much less than 40 seconds for
+commits since \fBcvs\fB servers can pause legitimately for just over 30 seconds
+while waiting to obtain a lock and can pause for an additional amount of time
+dependent on server load and the size of a commit when the user is attempting a
+commit.  It is recommended that servers do not set \fIwaitfor\fB to values
+under one hour since most \fBcvs\fB clients hold the connection to the server
+open while the user is constructing their log message.\fR
+.SP
+\fBThis value is not needed to detect broken TCP connections on most
+systems, but may still be used to detect and abort on rare error conditions
+like hung clients or servers which hold their network connections open, a
+condition undetectable using only the TCP stack.\fR
 .SP
 .IP "" 0
 \fB-v\fR
Index: ccvs/doc/cvs.texinfo
diff -u ccvs/doc/cvs.texinfo:1.678 ccvs/doc/cvs.texinfo:1.679
--- ccvs/doc/cvs.texinfo:1.678  Wed Apr  5 13:48:36 2006
+++ ccvs/doc/cvs.texinfo        Wed Apr  5 14:19:28 2006
@@ -8454,17 +8454,30 @@
 @cindex Connection timeout
 @cindex Timeout, network connections
 @cindex --timeout, global command line option
address@hidden --timeout @var{seconds}
address@hidden --timeout @var{waitfor}
 Time out network connections when no data is accepted by or received from the
-peer for @var{seconds} seconds.  It is recommended that @sc{cvs} clients do not
-set this value to less than 31 seconds for read operations or to a value
-much less than 40 seconds for commits since @sc{cvs} servers can pause
-legitimately for just over 30 seconds while waiting to obtain a lock and can
-pause for an additional amount of time dependent on server load and the size of
-a commit when the user is attempting a commit.  A value of zero for
address@hidden means to wait on the network indefinitely (or until the
+peer for the amount of time specified in @var{waitfor}.  @samp{d}, @samp{h},
address@hidden, and @samp{s} (days, hours, minutes, and seconds, respectively) 
are
+acceptable units when found at the end of @var{waitfor} (for example,
address@hidden, @samp{3h}, and @samp{40s} are all acceptable values for
address@hidden).  If no units are supplied, seconds are assumed.  A value of
+zero for @var{waitfor} means to wait on the network indefinitely (or until the
 connection is determined to be broken by other means, but this isn't always
-detectable on some systems).  @var{seconds} defaults to zero.
+detectable on some systems).  @var{waitfor} defaults to zero.
+
address@hidden is recommended that @sc{cvs} clients do not set this value to 
less
+than 31 seconds for read operations or to a value much less than 40 seconds for
+commits since @sc{cvs} servers can pause legitimately for just over 30 seconds
+while waiting to obtain a lock and can pause for an additional amount of time
+dependent on server load and the size of a commit when the user is attempting a
+commit.  It is recommended that servers do not set @var{waitfor} to values
+under one hour since most @sc{cvs} clients hold the connection to the server
+open while the user is constructing their log message.}
+
address@hidden value is not needed to detect broken TCP connections on most
+systems, but may still be used to detect and abort on rare error conditions
+like hung clients or servers which hold their network connections open, a
+condition undetectable using only the TCP stack.}
 
 @item -v
 @item --version