summaryrefslogtreecommitdiffstats
path: root/lib/lz4.h
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2018-02-18 19:00:33 (GMT)
committerYann Collet <cyan@fb.com>2018-02-18 19:00:33 (GMT)
commitd74f07974892aa5e8d1adc28b8ad9058e06fcadf (patch)
tree0961e77124cb76994ef77b8efeb615c76e654496 /lib/lz4.h
parent9f338ae204f4c04bb5b720f7bb804e764e4c820e (diff)
downloadlz4-d74f07974892aa5e8d1adc28b8ad9058e06fcadf.zip
lz4-d74f07974892aa5e8d1adc28b8ad9058e06fcadf.tar.gz
lz4-d74f07974892aa5e8d1adc28b8ad9058e06fcadf.tar.bz2
update API doc regarding double-buffer strategy
answering question #473
Diffstat (limited to 'lib/lz4.h')
-rw-r--r--lib/lz4.h4
1 files changed, 3 insertions, 1 deletions
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