diff options
| author | Yann Collet <cyan@fb.com> | 2019-04-11 21:15:33 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2019-04-11 21:15:33 (GMT) |
| commit | 8d76c8a44a15cc7c0c1f345ba750e44edac7abb7 (patch) | |
| tree | 520f596bf16fc20a94201b1371efec1c5a694522 /lib/README.md | |
| parent | 013fee5665cbf03113c1c2e78d5b50fa9663b306 (diff) | |
| download | lz4-8d76c8a44a15cc7c0c1f345ba750e44edac7abb7.zip lz4-8d76c8a44a15cc7c0c1f345ba750e44edac7abb7.tar.gz lz4-8d76c8a44a15cc7c0c1f345ba750e44edac7abb7.tar.bz2 | |
introduce LZ4_DISTANCE_MAX build macro
make it possible to generate LZ4-compressed block
with a controlled maximum offset (necessarily <= 65535).
This could be useful for compatibility with decoders
using a very limited memory budget (<64 KB).
Answer #154
Diffstat (limited to 'lib/README.md')
| -rw-r--r-- | lib/README.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md index be8eba0..c6daaea 100644 --- a/lib/README.md +++ b/lib/README.md @@ -52,6 +52,13 @@ The following build macro can be determined at compilation time : For example, with `gcc` : `-DLZ4_FAST_DEC_LOOP=1`, and with `make` : `CPPFLAGS+=-DLZ4_FAST_DEC_LOOP=1 make lz4`. +- `LZ4_DISTANCE_MAX` : control the maximum offset that the compressor will allow. + Set to 65535 by default, which is the maximum value supported by lz4 format. + Reducing maximum distance will reduce opportunities for LZ4 to find matches, + hence will produce worse the compression ratio. + However, a smaller max distance may allow compatibility with specific decoders using limited memory budget. + This build macro only influences the compressed output of the compressor. + - `LZ4_DISABLE_DEPRECATE_WARNINGS` : invoking a deprecated function will make the compiler generate a warning. This is meant to invite users to update their source code. Should this be a problem, it's generally to make the compiler ignore these warnings, |