]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
doc: legacy support is now disabled by default
authorYann Collet <cyan@fb.com>
Thu, 18 Dec 2025 21:19:11 +0000 (13:19 -0800)
committerYann Collet <cyan@fb.com>
Thu, 18 Dec 2025 21:19:11 +0000 (13:19 -0800)
CHANGELOG
lib/README.md

index 92df0f462ee01b13aa87baee684a7f45afbc5d83..eb46d7118720a082d76474380cdbe4fd33c7fd2e 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -1,3 +1,7 @@
+v1.6.0 (Dec 2025)
+api: legacy format support is now disabled by default
+build: `ZSTD_LEGACY_SUPPORT` defaults to `0` in Makefile and CMake
+
 V1.5.7 (Feb 2025)
 fix: compression bug in 32-bit mode associated with long-lasting sessions
 api: new method `ZSTD_compressSequencesAndLiterals()` (#4217, #4232)
index 3974de160ec0669fb05a267edc16d74e41bdb4f9..aa92bd659daea0f3ea2b6e08606b366c678eb368 100644 (file)
@@ -12,8 +12,9 @@ including commands variables, staged install, directory variables and standard t
 - `make` : generates both static and dynamic libraries
 - `make install` : install libraries, headers and pkg-config in local system directories
 
-`libzstd` default scope is extensive, including compression, decompression, dictionary builder,
-and support for decoding legacy formats >= v0.5.0 by default.
+`libzstd` default scope includes compression, decompression, and dictionary builder.
+Note: starting v1.6.0, support for decoding legacy formats is disabled by default.
+See _modular build_ below to learn how to enable it.
 The scope can be reduced on demand (see paragraph _modular build_).
 
 #### Multiarch Support
@@ -99,7 +100,7 @@ The file structure is designed to make this selection manually achievable for an
         Specifying a number limits versions supported to that version onward.
         For example, `ZSTD_LEGACY_SUPPORT=2` means : "support legacy formats >= v0.2.0".
         Conversely, `ZSTD_LEGACY_SUPPORT=0` means "do __not__ support legacy formats".
-        By default, this build macro is set as `ZSTD_LEGACY_SUPPORT=5`.
+        By default, this build macro is set as `ZSTD_LEGACY_SUPPORT=0` (disabled).
         Decoding supported legacy format is a transparent capability triggered within decompression functions.
         It's also allowed to invoke legacy API directly, exposed in `lib/legacy/zstd_legacy.h`.
         Each version does also provide its own set of advanced API.