diff options
| author | Yann Collet <cyan@fb.com> | 2022-09-13 01:34:48 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2022-09-13 01:34:48 (GMT) |
| commit | 72b9348f023479b7d9afb4b7c2c8a666e82ff7a8 (patch) | |
| tree | c7b2873546c8e806bd7ca899278a6d4d0ca9fbf5 /lib/README.md | |
| parent | 32bfb209d36ff7a32282771f7dba4e378b10cb10 (diff) | |
| download | lz4-72b9348f023479b7d9afb4b7c2c8a666e82ff7a8.zip lz4-72b9348f023479b7d9afb4b7c2c8a666e82ff7a8.tar.gz lz4-72b9348f023479b7d9afb4b7c2c8a666e82ff7a8.tar.bz2 | |
Clarifiy documentation for LZ4F_HEAPMODE
Now it's only about LZ4F_compressFrame(),
and it's only about the Compression Context
(not the hash tables, which used to be integrated).
Diffstat (limited to 'lib/README.md')
| -rw-r--r-- | lib/README.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/README.md b/lib/README.md index 08d1cef..94e0161 100644 --- a/lib/README.md +++ b/lib/README.md @@ -100,7 +100,7 @@ The following build macro can be selected to adjust source code behavior at comp passed as argument to become a compression state is suitably aligned. This test can be disabled if it proves flaky, by setting this value to 0. -- `LZ4_USER_MEMORY_FUNCTIONS` : replace calls to `<stdlib,h>`'s `malloc()`, `calloc()` and `free()` +- `LZ4_USER_MEMORY_FUNCTIONS` : replace calls to `<stdlib.h>`'s `malloc()`, `calloc()` and `free()` by user-defined functions, which must be named `LZ4_malloc()`, `LZ4_calloc()` and `LZ4_free()`. User functions must be available at link time. @@ -115,6 +115,8 @@ The following build macro can be selected to adjust source code behavior at comp (embedded, bootloader, etc). For more details, see description of this macro in `lib/lz4.h`. +- `LZ4F_HEAPMODE` : selects how `LZ4F_compressFrame()` allocates the compression state, + either on stack (default, value 0) or using heap memory (value 1). #### Amalgamation |