summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorTakayuki Matsuoka <t-mat@users.noreply.github.com>2022-08-11 07:13:56 (GMT)
committerTakayuki Matsuoka <t-mat@users.noreply.github.com>2022-08-11 07:13:56 (GMT)
commitb41ee9935d4fdd8051ec89f0a14682c6821aa6ae (patch)
tree8ff793ac343e2efec6a07c0350a4865103a69068 /lib
parent67c321935bf188d40a7ed208d30513bf6cfd6b98 (diff)
downloadlz4-b41ee9935d4fdd8051ec89f0a14682c6821aa6ae.zip
lz4-b41ee9935d4fdd8051ec89f0a14682c6821aa6ae.tar.gz
lz4-b41ee9935d4fdd8051ec89f0a14682c6821aa6ae.tar.bz2
Add short description of LZ4_FREESTANDING and _DISABLE_MEMORY_ALLOCATION
Diffstat (limited to 'lib')
-rw-r--r--lib/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md
index 244d65c..c9916a9 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