]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
Add Documentation to lib/README.md
authorW. Felix Handte <w@felixhandte.com>
Thu, 4 May 2023 16:20:02 +0000 (12:20 -0400)
committerW. Felix Handte <w@felixhandte.com>
Thu, 4 May 2023 16:20:02 +0000 (12:20 -0400)
lib/README.md

index c3b5d1817f310633d2824309f5d52c275ef9f418..2da16647a7fb2f2c3a51d2839f93f96e5b42c0d8 100644 (file)
@@ -119,6 +119,12 @@ The file structure is designed to make this selection manually achievable for an
   binary is achieved by using `HUF_FORCE_DECOMPRESS_X1` and
   `ZSTD_FORCE_DECOMPRESS_SEQUENCES_SHORT` (implied by `ZSTD_LIB_MINIFY`).
 
+  On the compressor side, Zstd's compression levels map to several internal
+  strategies. In environments where the higher compression levels aren't used,
+  it is possible to exclude all but the fastest strategy with
+  `ZSTD_LIB_EXCLUDE_COMPRESSORS_DFAST_AND_UP=1`. (Note that this will change
+  the behavior of the default compression level.)
+
   For squeezing the last ounce of size out, you can also define
   `ZSTD_NO_INLINE`, which disables inlining, and `ZSTD_STRIP_ERROR_STRINGS`,
   which removes the error messages that are otherwise returned by