Skip to content

Commit add3a05

Browse files
committed
feat: support package builders to allow configuring certain C dependencies
Namely, `zlib` and sha1 hashing.
1 parent 13a0f1e commit add3a05

File tree

2 files changed

+43
-4
lines changed

2 files changed

+43
-4
lines changed

Cargo.toml

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,18 @@ default = ["max"]
3131
## Everything, all at once.
3232
##
3333
## As fast as possible, with TUI progress, progress line rendering with auto-configuration, all transports based on their most mature implementation (HTTP), all `ein` tools, CLI colors and local-time support, JSON output, regex support for rev-specs.
34-
max = ["fast", "pretty-cli", "http-client-curl", "gitoxide-core-tools-query", "gitoxide-core-tools", "gitoxide-core-blocking-client", "prodash-render-line", "prodash-render-tui", "prodash/render-line-autoconfigure", "gix/regex" ]
34+
max = ["max-control", "fast", "gitoxide-core-blocking-client", "http-client-curl"]
3535

3636
## Like `max`, but only Rust is allowed.
3737
##
3838
## This is the most compatible build as it won't need a C compiler or C toolchains to build. It's also not the fastest as or the most feature-rich in terms of available
3939
## transports as it uses Rust's HTTP implementation.
4040
##
4141
## As fast as possible, with TUI progress, progress line rendering with auto-configuration, all transports available but less mature pure Rust HTTP implementation, all `ein` tools, CLI colors and local-time support, JSON output, regex support for rev-specs.
42-
max-pure = ["pretty-cli", "gix-features/rustsha1", "gix-features/zlib-rust-backend", "prodash-render-line", "prodash-render-tui", "gix/max-performance-safe", "gix/comfort", "http-client-reqwest", "gitoxide-core-blocking-client", "gitoxide-core-tools", "prodash/render-line-autoconfigure", "gix/regex" ]
42+
max-pure = ["max-control", "gix-features/rustsha1", "gix-features/zlib-rust-backend", "http-client-reqwest", "gitoxide-core-blocking-client" ]
43+
44+
## Like `max`, but with more control for configuration. See the *Package Maintainers* headline for more information.
45+
max-control = ["fast-safe", "pretty-cli", "gitoxide-core-tools-query", "gitoxide-core-tools", "prodash-render-line", "prodash-render-tui", "prodash/render-line-autoconfigure", "gix/regex" ]
4346

4447
## All of the good stuff, with less fanciness for smaller binaries.
4548
##
@@ -64,6 +67,29 @@ small = ["pretty-cli", "gix-features/rustsha1", "gix-features/zlib-rust-backend"
6467
## It uses, however, a fully asynchronous networking implementation which can serve a real-world example on how to implement custom async transports.
6568
lean-async = ["fast", "pretty-cli", "gitoxide-core-tools", "gitoxide-core-tools-query", "gitoxide-core-async-client", "prodash-render-line"]
6669

70+
#! ### Package Maintainers
71+
#! `*-control` features leave it to you to configure C libraries, involving choices for `zlib`, ! hashing and transport implementation.
72+
#!
73+
#! Additional features *can* be provided with `--features` and are handled by the [`gix-features` crate](https://docs.rs/gix-features/latest).
74+
#! If nothing else is specified, the Rust implementation is used. ! Note that only one feature of each section can be enabled at a time.
75+
#!
76+
#! * **zlib**
77+
#! - `gix-features/zlib-ng`
78+
#! - `gix-features/zlib-ng-compat`
79+
#! - `gix-features/zlib-stock`
80+
#! - `gix-features/zlib-rust-backend` (*default if no choice is made*)
81+
#! * **sha1**
82+
#! - `gix-features/fast-sha1`
83+
#! - `gix-features/rustsha1` (*default if no choice is made*)
84+
#! * **HTTP** - see the *Building Blocks for mutually exclusive networking* headline
85+
#!
86+
#! #### Examples
87+
#!
88+
#! * `cargo build --release --no-default-features --features max-control,gix-features/zlib-stock,gitoxide-core-blocking-client,http-client-curl`
89+
#! - Create a build just like `max`, but using the stock `zlib` library instead of `zlib-ng`
90+
#! * `cargo build --release --no-default-features --features max-control,http-client-reqwest,gitoxide-core-blocking-client,gix-features/fast-sha1`
91+
#! - Create a build just like `max-pure`, but with faster hashing due to `fast-sha1`.
92+
6793
#! ### Building Blocks
6894
#! Typical combinations of features of our dependencies, some of which are referred to in the `gitoxide` crate's code for conditional compilation.
6995

@@ -72,6 +98,11 @@ lean-async = ["fast", "pretty-cli", "gitoxide-core-tools", "gitoxide-core-tools-
7298
## If disabled, the binary will be visibly smaller.
7399
fast = ["gix/max-performance", "gix/comfort"]
74100

101+
## Makes the crate execute as fast as possible by supporting parallel computation of otherwise long-running functions
102+
## as well as fast, hardware accelerated hashing, along with a faster zlib backend.
103+
## If disabled, the binary will be visibly smaller.
104+
fast-safe = ["gix/max-performance-safe", "gix/comfort"]
105+
75106
## Use `clap` 3.0 to build the prettiest, best documented and most user-friendly CLI at the expense of binary size.
76107
## Provides a terminal user interface for detailed and exhaustive progress.
77108
## Provides a line renderer for leaner progress display, without the need for a full-blown TUI.
@@ -98,14 +129,21 @@ gitoxide-core-tools = ["gitoxide-core/organize", "gitoxide-core/estimate-hours"]
98129
gitoxide-core-tools-query = ["gitoxide-core-tools", "gitoxide-core/query"]
99130

100131
#! ### Building Blocks for mutually exclusive networking
101-
#! If some of these are set at the same time a compile error is triggered. This also means that `cargo … --all-features` will fail.
102-
132+
#! Blocking and async features are mutually exclusive and cause a compile-time error. This also means that `cargo … --all-features` will fail.
133+
#! Within each section, features can be combined.
134+
#!
135+
#! #### Blocking
136+
#! The backends are mutually exclusive, e.g. choose either `curl` or `request`.
137+
#!
103138
## Use blocking client networking.
104139
gitoxide-core-blocking-client = ["gitoxide-core/blocking-client"]
105140
## Support synchronous 'http' and 'https' transports (e.g. for clone, fetch and push) using **curl**.
106141
http-client-curl = ["gix/blocking-http-transport-curl"]
107142
## Support synchronous 'http' and 'https' transports (e.g. for clone, fetch and push) using **reqwest**.
108143
http-client-reqwest = ["gix/blocking-http-transport-reqwest-rust-tls"]
144+
145+
#! #### Async
146+
#!
109147
## Use async client networking.
110148
gitoxide-core-async-client = ["gitoxide-core/async-client", "futures-lite"]
111149

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ check: ## Build all code in suitable configurations
141141
&& cargo check --no-default-features
142142
cd gix-odb && cargo check --features serde
143143
cd cargo-smart-release && cargo check --all && cargo check --features vendored-openssl
144+
cargo check --no-default-features --features max-control
144145

145146
unit-tests: ## run all unit tests
146147
cargo test --all

0 commit comments

Comments
 (0)