From: Mark Adler <madler@alumni.caltech.edu>
Date: Wed, 29 Jul 2015 06:17:49 +0000 (-0700)
Subject: Clarify deflateReset() documentation.
X-Git-Tag: 1.9.9-b1~793^2~20
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9052d51ee5e8844e96c17554a5b34ee88295c9b3;p=thirdparty%2Fzlib-ng.git

Clarify deflateReset() documentation.

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)
---

diff --git a/zlib.h b/zlib.h
index bf9063099..92016ba4e 100644
--- 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).