diff options
| author | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2022-08-11 16:13:56 +0900 |
|---|---|---|
| committer | Takayuki Matsuoka <t-mat@users.noreply.github.com> | 2022-08-11 16:13:56 +0900 |
| commit | b41ee9935d4fdd8051ec89f0a14682c6821aa6ae (patch) | |
| tree | 8ff793ac343e2efec6a07c0350a4865103a69068 | |
| parent | 67c321935bf188d40a7ed208d30513bf6cfd6b98 (diff) | |
| download | lz4-b41ee9935d4fdd8051ec89f0a14682c6821aa6ae.tar.gz | |
Add short description of LZ4_FREESTANDING and _DISABLE_MEMORY_ALLOCATION
| -rw-r--r-- | lib/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md index 244d65ce..c9916a98 100644 --- a/lib/README.md +++ b/lib/README.md @@ -104,6 +104,18 @@ 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_STATIC_LINKING_ONLY_DISABLE_MEMORY_ALLOCATION` : some LZ4/HC (level 1 and 2) public + functions internally invoke dynamic memory allocation functions of the C standard library. + By defining this build macro, these LZ4/HC functions are disabled to ensure to remove + dependency to the standard library. + See also the description of this macro in lib/lz4.c. + +- `LZ4_FREESTANDING` : by setting this build macro to 1, LZ4/HC (level 1 and 2) removes + dependencies on the C standard library, including memmove, memcpy, and memset. + This build macro is designed to help use LZ4/HC in restricted environments + (embedded, bootloader, etc). + See also the description of this macro in lib/lz4.h. + #### Amalgamation |