ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: legacy support is now disabled by default

Browse Source
This commit is contained in:
Yann Collet
2025-12-18 13:19:11 -08:00
parent 073c7fb6ea
commit 6c3e805e50
2 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG
+4
View File
@@ -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) V1.5.7 (Feb 2025)
fix: compression bug in 32-bit mode associated with long-lasting sessions fix: compression bug in 32-bit mode associated with long-lasting sessions
api: new method `ZSTD_compressSequencesAndLiterals()` (#4217, #4232) api: new method `ZSTD_compressSequencesAndLiterals()` (#4217, #4232)
lib/README.md
+4 -3
View File
@@ -12,8 +12,9 @@ including commands variables, staged install, directory variables and standard t
- `make` : generates both static and dynamic libraries - `make` : generates both static and dynamic libraries
- `make install` : install libraries, headers and pkg-config in local system directories - `make install` : install libraries, headers and pkg-config in local system directories
`libzstd` default scope is extensive, including compression, decompression, dictionary builder, `libzstd` default scope includes compression, decompression, and dictionary builder.
and support for decoding legacy formats >= v0.5.0 by default. 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_). The scope can be reduced on demand (see paragraph _modular build_).
#### Multiarch Support #### 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. Specifying a number limits versions supported to that version onward.
For example, `ZSTD_LEGACY_SUPPORT=2` means : "support legacy formats >= v0.2.0". For example, `ZSTD_LEGACY_SUPPORT=2` means : "support legacy formats >= v0.2.0".
Conversely, `ZSTD_LEGACY_SUPPORT=0` means "do __not__ support legacy formats". 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. 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`. 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. Each version does also provide its own set of advanced API.