summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorsebres <sebres@users.sourceforge.net>2020-04-16 14:37:05 (GMT)
committersebres <sebres@users.sourceforge.net>2020-04-16 14:37:05 (GMT)
commitbecf4bcc18eb7b7114f65c271b21d9d7d6c94d2a (patch)
tree7aedf49bdb299ece6a72eb38d6bedf1fe96e1628 /doc
parentfb7b5ca9d3d2253238c7a1923dcb211d5cdee7fb (diff)
downloadtcl-becf4bcc18eb7b7114f65c271b21d9d7d6c94d2a.zip
tcl-becf4bcc18eb7b7114f65c271b21d9d7d6c94d2a.tar.gz
tcl-becf4bcc18eb7b7114f65c271b21d9d7d6c94d2a.tar.bz2
few documentation changes (limit default and handling is changed)
Diffstat (limited to 'doc')
-rw-r--r--doc/zlib.n16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/zlib.n b/doc/zlib.n
index fd29e0d..994a063 100644
--- a/doc/zlib.n
+++ b/doc/zlib.n
@@ -193,10 +193,12 @@ How hard to compress the data. Must be an integer from 0 (uncompressed) to 9
.TP
\fB\-limit\fI readaheadLimit\fR
.
-The maximum number of bytes ahead to read when decompressing. This defaults to
-1, which ensures that data is always decompressed correctly, but may be
-increased to improve performance. This is more useful when the channel is
-non-blocking.
+The maximum number of bytes ahead to read when decompressing. This can be set
+to 1 to find the border for multi-stream inflate or mixed data, to ensure it
+would handle correctly e. g. some operations on following streams after first
+caused to due time.
+Otherwise Tcl would try to automatically return previously read extra data
+to input stream back.
.PP
Both compressing and decompressing channel transformations add extra
configuration options that may be accessed through \fBchan configure\fR. The
@@ -238,10 +240,8 @@ off the data stream.
\fB\-limit\fI readaheadLimit\fR
.
This read-write option is used by decompressing channels to control the
-maximum number of bytes ahead to read from the underlying data source. This
-defaults to 1, which ensures that data is always decompressed correctly, but
-may be increased to improve performance. This is more useful when the channel
-is non-blocking.
+maximum number of bytes ahead to read from the underlying data source. See
+above for more information.
.RE
.SS "STREAMING SUBCOMMAND"
.TP