]> git.ipfire.org Git - thirdparty/zlib-ng.git/commitdiff
Document the rejection of 256-byte window requests in zlib.h.
authorMark Adler <madler@alumni.caltech.edu>
Mon, 24 Oct 2016 23:00:51 +0000 (16:00 -0700)
committerHans Kristian Rosbach <hk-git@circlestorm.org>
Wed, 1 Feb 2017 11:10:31 +0000 (12:10 +0100)
zlib.h

diff --git a/zlib.h b/zlib.h
index f2c82a40363198fa891c0c5bf30f21460393211b..48187e9caa090cebaf00fefe2101cd75d77dc844 100644 (file)
--- a/zlib.h
+++ b/zlib.h
@@ -560,6 +560,10 @@ ZEXTERN int ZEXPORT deflateInit2 (z_stream *strm,
    header crc, and the operating system will be set to 255 (unknown).  If a
    gzip stream is being written, strm->adler is a crc32 instead of an adler32.
 
+     For raw deflate or gzip encoding, a request for a 256-byte window is
+   rejected as invalid, since only the zlib header provides a means of
+   transmitting the window size to the decompressor.
+
      The memLevel parameter specifies how much memory should be allocated
    for the internal compression state.  memLevel=1 uses minimum memory but is
    slow and reduces compression ratio; memLevel=9 uses maximum memory for