Skip to content

Commit c954bbf

Browse files
committed
Add feature to link to traditional zlib for dynamic linking support
1 parent 9245083 commit c954bbf

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

git-features/Cargo.toml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,16 @@ crc32 = ["crc32fast"]
3636
#! ### Mutually Exclusive ZLIB
3737

3838
## Enable the usage of zlib related utilities to compress or decompress data.
39-
## By default it uses a pure rust implementation which is slower than the **zlib-ng-compat** version, but might be relevant if you prefer a pure-rust build
40-
## and reduced performance is acceptable. Note that a competitive Zlib implementation is critical to `gitoxide's` object database performance.
39+
## By default it uses a pure rust implementation which is slower than the **zlib-ng-compat** or **zlib-stock** versions, but might be relevant if you prefer a pure-rust build
40+
## and reduced performance is acceptable. **zlib-stock** can be used if dynamic linking of an external zlib library is desired or if cmake is not available.
41+
## Note that a competitive Zlib implementation is critical to `gitoxide's` object database performance.
4142
## Additional backends are supported, each of which overriding the default Rust backend.
4243
zlib = ["flate2", "flate2/rust_backend", "quick-error"]
43-
## Use a C-based backend which can compress and decompress significantly faster.
44+
## Use a C-based backend which can compress and decompress significantly faster than the other options.
4445
zlib-ng-compat = ["flate2/zlib-ng-compat"]
46+
## Use a slower C-based backend which can compress and decompress significantly faster than the rust version.
47+
## Unlike `zlib-ng-compat`, this allows using dynamic linking with system `zlib` libraries and doesn't require cmake.
48+
zlib-stock = ["flate2/zlib"]
4549
## available for completeness even though it's the default - it may be chosen for more specific feature flag names, instead of a bare `zlib`.
4650
zlib-rust-backend = ["flate2/rust_backend"]
4751

0 commit comments

Comments
 (0)