summaryrefslogtreecommitdiffstats
path: root/doc/zlib.n
diff options
context:
space:
mode:
authoraku <andreas.kupries@gmail.com>2020-06-23 06:37:59 (GMT)
committeraku <andreas.kupries@gmail.com>2020-06-23 06:37:59 (GMT)
commitdbc3e640a2807e90bad8ebaef6f4ebb06178a18c (patch)
tree34527bf036e8b44ca63d9df460f6130110c69433 /doc/zlib.n
parentb0791473e99d375f6f3b65b13f99728e552f2b5a (diff)
downloadtcl-dbc3e640a2807e90bad8ebaef6f4ebb06178a18c.zip
tcl-dbc3e640a2807e90bad8ebaef6f4ebb06178a18c.tar.gz
tcl-dbc3e640a2807e90bad8ebaef6f4ebb06178a18c.tar.bz2
Added two tests demonstrating that the tickets [8af92dfb66] (bad stream expansion) and [f70ce1fead] (multi-stream decoding without readahead limit shenanigans) are fixed.
Verified that the tests fail with commit [4eb66645d6], just before the zlib fixes. Tweaked the zlib manpage paragraphs about -limit. Tweaked some code comments. Fixed typos in description of two unrelated zlib tests.
Diffstat (limited to 'doc/zlib.n')
-rw-r--r--doc/zlib.n18
1 files changed, 12 insertions, 6 deletions
diff --git a/doc/zlib.n b/doc/zlib.n
index 994a063..3714fc1 100644
--- a/doc/zlib.n
+++ b/doc/zlib.n
@@ -193,12 +193,18 @@ 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 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.
+The maximum number of bytes ahead to read when decompressing.
+.RS
+.PP
+This option has become \fBirrelevant\fR. It was originally introduced
+to prevent Tcl from reading beyond the end of a compressed stream in
+multi-stream channels to ensure that the data after was left alone for
+further reading, at the cost of speed.
+.PP
+Tcl now automatically returns any bytes it has read beyond the end of
+a compressed stream back to the channel, making them appear as unread
+to further readers.
+.RE
.PP
Both compressing and decompressing channel transformations add extra
configuration options that may be accessed through \fBchan configure\fR. The