]> git.lizzy.rs Git - zlib.git/commitdiff
Clarify deflateReset() documentation.
authorMark Adler <madler@alumni.caltech.edu>
Wed, 29 Jul 2015 06:17:49 +0000 (23:17 -0700)
committerMark Adler <madler@alumni.caltech.edu>
Wed, 29 Jul 2015 06:19:50 +0000 (23:19 -0700)
It previously could have been misinterpreted to mean that parameter
changes after deflateInit2() would be reversed, which is not the
case.

zlib.h

diff --git a/zlib.h b/zlib.h
index c563014d5af9c99d29c749f011514098a9e41162..7ec5fa80cc1ae2e0ec765bee814ef254385918ac 100644 (file)
--- a/zlib.h
+++ b/zlib.h
@@ -656,10 +656,10 @@ ZEXTERN int ZEXPORT deflateCopy OF((z_streamp dest,
 
 ZEXTERN int ZEXPORT deflateReset OF((z_streamp strm));
 /*
-     This function is equivalent to deflateEnd followed by deflateInit,
-   but does not free and reallocate all the internal compression state.  The
-   stream will keep the same compression level and any other attributes that
-   may have been set by deflateInit2.
+     This function is equivalent to deflateEnd followed by deflateInit, but
+   does not free and reallocate the internal compression state.  The stream
+   will leave the compression level and any other attributes that may have been
+   set unchanged.
 
      deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source
    stream state was inconsistent (such as zalloc or state being Z_NULL).