]> git.ipfire.org Git - thirdparty/zlib-ng.git/commitdiff
Note in zlib.h that compress() uses Z_DEFAULT_COMPRESSION.
authorMark Adler <madler@alumni.caltech.edu>
Sat, 26 Apr 2014 15:12:37 +0000 (08:12 -0700)
committerHans Kristian Rosbach <hk-git@circlestorm.org>
Tue, 3 Nov 2015 17:53:04 +0000 (18:53 +0100)
zlib.h

diff --git a/zlib.h b/zlib.h
index e06cbaad21bdc9bff162e351433246206c2d1e67..56bfbba08296e9bab89c45c8a20e2cc431730066 100644 (file)
--- a/zlib.h
+++ b/zlib.h
@@ -1154,7 +1154,8 @@ ZEXTERN int ZEXPORT compress(unsigned char *dest, uLong *destLen, const unsigned
    the byte length of the source buffer.  Upon entry, destLen is the total size
    of the destination buffer, which must be at least the value returned by
    compressBound(sourceLen).  Upon exit, destLen is the actual size of the
-   compressed buffer.
+   compressed buffer.  compress() is equivalent to compress2() with a level
+   parameter of Z_DEFAULT_COMPRESSION.
 
      compress returns Z_OK if success, Z_MEM_ERROR if there was not
    enough memory, Z_BUF_ERROR if there was not enough room in the output