]> git.ipfire.org Git - thirdparty/zlib-ng.git/commitdiff
Clarify deflateReset() documentation.
authorMark Adler <madler@alumni.caltech.edu>
Wed, 29 Jul 2015 06:17:49 +0000 (23:17 -0700)
committerHans Kristian Rosbach <hk-git@circlestorm.org>
Tue, 3 Nov 2015 14:45:20 +0000 (15:45 +0100)
It previously could have been misinterpreted to mean that parameter
changes after deflateInit2() would be reversed, which is not the
case.

(cherry picked from commit 5701f48cf5178355b1ec51614d44aa14251250e5)

zlib.h

diff --git a/zlib.h b/zlib.h
index bf906309944ffcf1d00ee4acb50aa31e200c4136..92016ba4ef21aec7432b5e8dc1b6d631f4b838f6 100644 (file)
--- a/zlib.h
+++ b/zlib.h
@@ -652,10 +652,10 @@ ZEXTERN int ZEXPORT deflateCopy(z_stream *dest, z_stream *source);
 
 ZEXTERN int ZEXPORT deflateReset(z_stream *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).