From 0e96d8e7c7079ab9f07cc7b57ae3ca9de8c80742 Mon Sep 17 00:00:00 2001 From: Mark Adler Date: Fri, 5 Apr 2019 15:27:47 -0700 Subject: [PATCH] Explicitly note that the 32-bit check values are 32 bits. --- zlib.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/zlib.h b/zlib.h index d33db136a..18ce4331b 100644 --- a/zlib.h +++ b/zlib.h @@ -1690,8 +1690,9 @@ ZEXTERN void ZEXPORT gzclearerr OF((gzFile file)); ZEXTERN uLong ZEXPORT adler32 OF((uLong adler, const Bytef *buf, uInt len)); /* Update a running Adler-32 checksum with the bytes buf[0..len-1] and - return the updated checksum. If buf is Z_NULL, this function returns the - required initial value for the checksum. + return the updated checksum. An Adler-32 value is in the range of a 32-bit + unsigned integer. If buf is Z_NULL, this function returns the required + initial value for the checksum. An Adler-32 checksum is almost as reliable as a CRC-32 but can be computed much faster. @@ -1727,9 +1728,10 @@ ZEXTERN uLong ZEXPORT adler32_combine OF((uLong adler1, uLong adler2, ZEXTERN uLong ZEXPORT crc32 OF((uLong crc, const Bytef *buf, uInt len)); /* Update a running CRC-32 with the bytes buf[0..len-1] and return the - updated CRC-32. If buf is Z_NULL, this function returns the required - initial value for the crc. Pre- and post-conditioning (one's complement) is - performed within this function so it shouldn't be done by the application. + updated CRC-32. A CRC-32 value is in the range of a 32-bit unsigned integer. + If buf is Z_NULL, this function returns the required initial value for the + crc. Pre- and post-conditioning (one's complement) is performed within this + function so it shouldn't be done by the application. Usage example: