From d74f07974892aa5e8d1adc28b8ad9058e06fcadf Mon Sep 17 00:00:00 2001 From: Yann Collet Date: Sun, 18 Feb 2018 11:00:33 -0800 Subject: update API doc regarding double-buffer strategy answering question #473 --- doc/lz4_manual.html | 4 +++- lib/lz4.h | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/lz4_manual.html b/doc/lz4_manual.html index ef715f8..b5a4042 100644 --- a/doc/lz4_manual.html +++ b/doc/lz4_manual.html @@ -178,7 +178,9 @@ int LZ4_freeStream (LZ4_stream_t* streamPtr); Important : The previous 64KB of compressed data is assumed to remain preset and unmodified in memory! If less than 64KB has been compressed all the data must be present. - Special 1 : If input buffer is a double-buffer, it can have any size, including < 64 KB. + Special 1 : When input is a double-buffer, they can have any size, including < 64 KB. + Make sure that buffers are separated by at least one byte. + This way, rule becomes simple : each block depends on previous block only. Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB. @return : size of compressed block diff --git a/lib/lz4.h b/lib/lz4.h index c5d50e2..08f06c7 100644 --- a/lib/lz4.h +++ b/lib/lz4.h @@ -266,7 +266,9 @@ LZ4LIB_API int LZ4_loadDict (LZ4_stream_t* streamPtr, const char* dictionary, in * * Important : The previous 64KB of compressed data is assumed to remain preset and unmodified in memory! * If less than 64KB has been compressed all the data must be present. - * Special 1 : If input buffer is a double-buffer, it can have any size, including < 64 KB. + * Special 1 : When input is a double-buffer, they can have any size, including < 64 KB. + * Make sure that buffers are separated by at least one byte. + * This way, rule becomes simple : each block depends on previous block only. * Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB. * * @return : size of compressed block -- cgit v0.12