CVS update: /ccvs/doc/

User: dprice  
Date: 05/06/03 08:59:51

Modified:
 /ccvs/doc/
  ChangeLog, cvs.1, cvs.texinfo, cvsclient.texi, stamp-1, stamp-vti,
  version-client.texi, version.texi

Log:
 * cvs.texinfo (Global options): Note -z *requests* a compression level.
 (config): Describe MinCompressionLevel and MaxCompressionLevel.
 * cvsclient.texi (Responses): Add `Force-gzip' request.
 (Requests): Clarify `Gzip-stream' description.

File Changes:

Directory: /ccvs/doc/
=====================

File [changed]: ChangeLog
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/ChangeLog?r1=1.907&r2=1.908
Delta lines:  +7 -0
-------------------
--- ChangeLog	1 Jun 2005 20:17:15 -0000	1.907
+++ ChangeLog	3 Jun 2005 15:59:48 -0000	1.908
@@ -1,3 +1,10 @@
+2005-06-03  Derek Price  <[email protected]>
+
+	* cvs.texinfo (Global options): Note -z *requests* a compression level.
+	(config): Describe MinCompressionLevel and MaxCompressionLevel.
+	* cvsclient.texi (Responses): Add `Force-gzip' request.
+	(Requests): Clarify `Gzip-stream' description.
+
 2005-06-01  Derek Price  <[email protected]>
 
 	* cvs.texinfo (Connecting via rsh):  Cross-reference method options and

File [changed]: cvs.1
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/cvs.1?r1=1.28&r2=1.29
Delta lines:  +9 -5
-------------------
--- cvs.1	11 May 2005 20:59:35 -0000	1.28
+++ cvs.1	3 Jun 2005 15:59:48 -0000	1.29
@@ -414,16 +414,20 @@
 when you build \fBcvs\fR.
 .SP
 .IP "" 0
-\fB-z \fIgzip-level\fB\fR
+\fB-z \fIlevel\fB\fR
 .IP "" 2
 .IX "Compression"
 .IX "Gzip"
-Set the compression level.
+Request compression \fIlevel\fR for network traffic.
+\fBcvs\fR interprets \fIlevel\fR identically to the \fBgzip\fR program.
 Valid levels are 1 (high speed, low compression) to
 9 (low speed, high compression), or 0 to disable
-compression (the default).
-Only has an effect on the \fBcvs\fR client.
-.SP
+compression (the default).  Data sent to the server will
+be compressed at the requested level and the client will request
+the server use the same compression level for data returned.  The
+server will use the closest level allowed by the server administrator to
+compress returned data.  This option only has an effect when passed to
+the \fBcvs\fR client.
 .SP
 .SH "Common options"
 .SS "Common command options"

File [changed]: cvs.texinfo
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/cvs.texinfo?r1=1.642&r2=1.643
Delta lines:  +29 -5
--------------------
--- cvs.texinfo	1 Jun 2005 20:17:15 -0000	1.642
+++ cvs.texinfo	3 Jun 2005 15:59:48 -0000	1.643
@@ -8428,15 +8428,19 @@
 special configure option, @file{--enable-encryption},
 when you build @sc{cvs}.
 
-@item -z @var{gzip-level}
+@item -z @var{level}
 @cindex Compression
 @cindex Gzip
-Set the compression level.
+Request compression @var{level} for network traffic.
+@sc{cvs} interprets @var{level} identically to the @code{gzip} program.
 Valid levels are 1 (high speed, low compression) to
 9 (low speed, high compression), or 0 to disable
-compression (the default).
-Only has an effect on the @sc{cvs} client.
-
+compression (the default).  Data sent to the server will
+be compressed at the requested level and the client will request
+the server use the same compression level for data returned.  The
+server will use the closest level allowed by the server administrator to
+compress returned data.  This option only has an effect when passed to
+the @sc{cvs} client.
 @end table
 
 @c - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@@ -14660,6 +14664,26 @@
 be used exclusively (and @code{$@splitrcskeyword{Log}$} expansion skipped in
 files where the comment leader has not been set in the archive file), set
 @var{value} and set @code{MaxCommentLeaderLength} to @code{0}.
+
+@cindex MinCompressionLevel, in CVSROOT/config
+@cindex MaxCompressionLevel, in CVSROOT/config
+@cindex Compression levels, restricting on server
+@item MinCompressionLevel=@var{value}
+@itemx MaxCompressionLevel=@var{value}
+Restricts the level of compression used by the @sc{cvs} server to a @var{value}
+between 0 and 9.  @var{value}s 1 through 9 are the same @sc{zlib} compression
+levels accepted by the @samp{-z} option (@pxref{Global options}), and 0 means
+no compression.  When one or both of these keys are set and a client requests a
+level outside the specified range, the server will simply use the closest
+permissable level.  Clients will continue compressing at the level requested by
+the user.
+
+The exception is when level 0 (no compression) is not available and the client
+fails to request any compression.  The @sc{cvs} server will then exit with an
+error message when it becomes apparent that the client is not going to request
+compression.  This will not happen with clients version 1.12.13 and later since
+these client versions allow the server to notify them that they must request
+some level of compression.
 @end table
 
 

File [changed]: cvsclient.texi
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/cvsclient.texi?r1=1.140&r2=1.141
Delta lines:  +14 -6
--------------------
--- cvsclient.texi	3 May 2005 18:45:07 -0000	1.140
+++ cvsclient.texi	3 Jun 2005 15:59:48 -0000	1.141
@@ -1000,12 +1000,15 @@
 @item Gzip-stream @var{level} \n
 Response expected: no.
 Use zlib (RFC 1950/1951) compression to compress all further communication
-between the client and the server.  After this request is sent, all
-further communication must be compressed.  All further data received
-from the server will also be compressed.  The @var{level} argument
-suggests to the server the level of compression that it should apply; it
-should be an integer between 1 and 9, inclusive, where a higher number
-indicates more compression.
+between the client and the server.  As of @sc{cvs} 1.12.13, this request needs
+to be sent as the first non-rootless request if the server is configured
+with compression level restrictions and @var{level} is outside the restricted
+range.  After this request is sent, all further communication must be
+compressed.  All further data received from the server will also be
+compressed.  The @var{level} argument suggests to the server the level of
+compression that it should apply; it should be an integer between 0 and 9,
+inclusive, where @samp{0} means no compression and higher numbers indicate more
+compression.
 
 @item Kerberos-encrypt \n
 Response expected: no.
@@ -1509,6 +1512,11 @@
 patches, it will include @samp{update-patches} in this list.  The
 @samp{update-patches} request does not actually do anything.
 
+@item Force-gzip \n
+Response expected: no.
+Indicates that the server requires compression.  The client must send a
+@code{Gzip-stream} request, though the requested @var{level} may be @samp{0}.
+
 @item Referrer @var{CVSROOT}
 Request that the client store @var{CVSROOT} as the name of this server and that
 this name be passed via a @code{Referrer} @emph{request} to any subsequent

File [changed]: stamp-1
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/stamp-1?r1=1.66&r2=1.67
Delta lines:  +2 -2
-------------------
--- stamp-1	3 May 2005 18:45:07 -0000	1.66
+++ stamp-1	3 Jun 2005 15:59:48 -0000	1.67
@@ -1,4 +1,4 @@
-@set UPDATED 3 May 2005
-@set UPDATED-MONTH May 2005
+@set UPDATED 2 June 2005
+@set UPDATED-MONTH June 2005
 @set EDITION 1.12.12.1
 @set VERSION 1.12.12.1

File [changed]: stamp-vti
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/stamp-vti?r1=1.145&r2=1.146
Delta lines:  +1 -1
-------------------
--- stamp-vti	1 Jun 2005 20:17:16 -0000	1.145
+++ stamp-vti	3 Jun 2005 15:59:48 -0000	1.146
@@ -1,4 +1,4 @@
-@set UPDATED 1 June 2005
+@set UPDATED 2 June 2005
 @set UPDATED-MONTH June 2005
 @set EDITION 1.12.12.1
 @set VERSION 1.12.12.1

File [changed]: version-client.texi
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/version-client.texi?r1=1.66&r2=1.67
Delta lines:  +2 -2
-------------------
--- version-client.texi	3 May 2005 18:45:07 -0000	1.66
+++ version-client.texi	3 Jun 2005 15:59:48 -0000	1.67
@@ -1,4 +1,4 @@
-@set UPDATED 3 May 2005
-@set UPDATED-MONTH May 2005
+@set UPDATED 2 June 2005
+@set UPDATED-MONTH June 2005
 @set EDITION 1.12.12.1
 @set VERSION 1.12.12.1

File [changed]: version.texi
Url: https://ccvs.cvshome.org/source/browse/ccvs/doc/version.texi?r1=1.146&r2=1.147
Delta lines:  +1 -1
-------------------
--- version.texi	1 Jun 2005 20:17:16 -0000	1.146
+++ version.texi	3 Jun 2005 15:59:48 -0000	1.147
@@ -1,4 +1,4 @@
-@set UPDATED 1 June 2005
+@set UPDATED 2 June 2005
 @set UPDATED-MONTH June 2005
 @set EDITION 1.12.12.1
 @set VERSION 1.12.12.1