From c40bac31d3886c2f69d0364823b6d6aaa972ee5b Mon Sep 17 00:00:00 2001 From: Yann Collet Date: Fri, 13 Apr 2018 02:26:14 -0700 Subject: added comment on variables required after _next_match --- lib/lz4.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/lz4.c b/lib/lz4.c index c48aca4..54d037c 100644 --- a/lib/lz4.c +++ b/lib/lz4.c @@ -787,6 +787,14 @@ LZ4_FORCE_INLINE int LZ4_compress_generic( } _next_match: + /* at this stage, the following variables must be correctly set : + * - ip : at start of LZ operation + * - match : at start of previous pattern occurence; can be within current prefix, or within extDict + * - offset : if maybe_ext_memSegment==1 (constant) + * - lowLimit : must be == dictionary to mean "match is within extDict"; must be == source otherwise + * - token and *token : position to write 4-bits for match length; higher 4-bits for literal length supposed already written + */ + /* Encode Offset */ if (maybe_ext_memSegment) { /* static test */ assert(offset <= MAX_DISTANCE && offset > 0); -- cgit v0.12