Skip to content

Commit 5e618b6

Browse files
committed
review adjustments for zlib-rs support.
- adjust feature docs
1 parent 8b1b55c commit 5e618b6

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

gix-features/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ crc32 = ["dep:crc32fast"]
6666
zlib = ["dep:flate2", "flate2?/rust_backend", "dep:thiserror"]
6767
## Use the C-based zlib-ng backend, which can compress and decompress significantly faster.
6868
zlib-ng = ["zlib", "flate2?/zlib-ng"]
69-
## Use the rust-based zlib backend, which can compress and decompress significantly faster and is on par with zlib-ng or even faster.
69+
## Use the high-performance rust-based zlib backend en par with zlib-ng.
70+
## Note that this will cause duplicate symbol errors if the application also depends on `zlib`, without remediation.
7071
zlib-rs = ["zlib", "flate2?/zlib-rs"]
7172
## Use zlib-ng via its zlib-compat API. Useful if you already need zlib for C
7273
## code elsewhere in your dependencies. Otherwise, use zlib-ng.

gix/Cargo.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,8 @@ fast-sha1 = ["gix-features/fast-sha1"]
264264
## Note that this will cause duplicate symbol errors if the application also depends on `zlib` - use `zlib-ng-compat` in that case.
265265
zlib-ng = ["gix-features/zlib-ng"]
266266

267-
## Use the rust-based zlib backend, which can compress and decompress significantly faster and is on par with zlib-ng or even faster.
267+
## Use the high-performance rust-based zlib backend en par with zlib-ng.
268+
## Note that this will cause duplicate symbol errors if the application also depends on `zlib`, without remedy.
268269
zlib-rs = ["gix-features/zlib-rs"]
269270

270271
## Use zlib-ng via its zlib-compat API. Useful if you already need zlib for C

0 commit comments

Comments
 (0)