From c1b6c31da7d994bd72985526f39119a20036084c Mon Sep 17 00:00:00 2001 From: Eric Biggers Date: Mon, 1 Feb 2016 21:55:51 -0600 Subject: [PATCH] Document that NULL may be passed to deflate_compress_bound() --- libdeflate.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/libdeflate.h b/libdeflate.h index 476dffb..3da7b24 100644 --- a/libdeflate.h +++ b/libdeflate.h @@ -65,6 +65,10 @@ deflate_compress(struct deflate_compressor *compressor, * the true upper bound. The return value is guaranteed to be the same for all * invocations with the same compressor and same 'in_nbytes'. * + * As a special case, 'compressor' may be NULL. This causes the bound to be + * taken across *any* deflate_compressor that could ever be allocated with this + * build of the library, with any options. + * * Note that this function is not necessary in many applications. With * block-based compression, it is usually preferable to separately store the * uncompressed size of each block and to store any blocks that did not compress