Skip to content

Fix documentation of zlib-rs feature: no longer conflicts with other zlibs #1960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions gix-features/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,10 @@ crc32 = ["dep:crc32fast"]
zlib = ["dep:flate2", "flate2?/rust_backend", "dep:thiserror"]
## Use the C-based zlib-ng backend, which can compress and decompress significantly faster.
zlib-ng = ["zlib", "flate2?/zlib-ng"]
## Use the high-performance rust-based zlib backend en par with zlib-ng.
## Note that this will cause duplicate symbol errors if the application also depends on `zlib`, without remediation.
## Use the high-performance rust-based zlib backend on par with zlib-ng.
## As of zlib-rs 0.5.0 (used by flate2 1.1.1), this no longer exports C symbols
## by default, so it doesn't conflict with any other zlib library that might be
## loaded into the same address space.
zlib-rs = ["zlib", "flate2?/zlib-rs"]
## Use zlib-ng via its zlib-compat API. Useful if you already need zlib for C
## code elsewhere in your dependencies. Otherwise, use zlib-ng.
Expand Down
Loading