Skip to content

Commit f3684a4

Browse files
authored
Merge pull request #1960 from joshtriplett/zlib-rs
Fix documentation of zlib-rs feature: no longer conflicts with other zlibs
2 parents cd1a777 + 8ece02a commit f3684a4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

gix-features/Cargo.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,10 @@ crc32 = ["dep:crc32fast"]
6363
zlib = ["dep:flate2", "flate2?/rust_backend", "dep:thiserror"]
6464
## Use the C-based zlib-ng backend, which can compress and decompress significantly faster.
6565
zlib-ng = ["zlib", "flate2?/zlib-ng"]
66-
## Use the high-performance rust-based zlib backend en par with zlib-ng.
67-
## Note that this will cause duplicate symbol errors if the application also depends on `zlib`, without remediation.
66+
## Use the high-performance rust-based zlib backend on par with zlib-ng.
67+
## As of zlib-rs 0.5.0 (used by flate2 1.1.1), this no longer exports C symbols
68+
## by default, so it doesn't conflict with any other zlib library that might be
69+
## loaded into the same address space.
6870
zlib-rs = ["zlib", "flate2?/zlib-rs"]
6971
## Use zlib-ng via its zlib-compat API. Useful if you already need zlib for C
7072
## code elsewhere in your dependencies. Otherwise, use zlib-ng.

0 commit comments

Comments
 (0)