]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
[doc] Document new build macros in lib/README.md
authorNick Terrell <terrelln@fb.com>
Thu, 10 Sep 2020 00:13:16 +0000 (17:13 -0700)
committerNick Terrell <terrelln@fb.com>
Thu, 10 Sep 2020 00:13:16 +0000 (17:13 -0700)
lib/README.md

index 6ccffb13868caf287515c7af2895e3a49445f503..ff62b668a0f99390f0e1e50e1ec7afe41e336148 100644 (file)
@@ -143,6 +143,14 @@ The file structure is designed to make this selection manually achievable for an
   Setting this macro will either force to generate the BMI2 dispatcher (1)
   or prevent it (0). It overrides automatic detection.
 
+- The build macro `ZSTD_NO_UNUSED_FUNCTIONS` can be defined to hide the definitions of functions
+  that zstd does not use. Not all unused functions are hidden, but they can be if needed.
+  Currently, this macro will hide function definitions in FSE and HUF that use an excessive
+  amount of stack space.
+
+- The build macro `ZSTD_NO_INTRINSICS` can be defined to disable all explicit intrinsics.
+  Compiler builtins are still used.
+
 
 #### Windows : using MinGW+MSYS to create DLL