Merge pull request GitoxideLabs#2441 from cruessler/remove-sha-1-from-default-features

Remove `sha1` from default features in `gix-hash`

Author: Byron

.github/workflows/ci.yml

@@ -558,22 +558,15 @@ jobs:
             gix-bitmap
             gix-chunk
             gix-command
-            gix-commitgraph
             gix-config-value
             gix-date
             gix-glob
-            gix-hash
-            gix-hashtable
             gix-mailmap
-            gix-object
             gix-packetline
             gix-path
             gix-pathspec
             gix-prompt
             gix-quote
-            gix-refspec
-            gix-revision
-            gix-traverse
             gix-url
             gix-validate
           )
@@ -587,11 +580,26 @@ jobs:
           for feature in progress parallel io-pipe crc32 zlib cache-efficiency-debug; do
             cargo build -p gix-features --features "$feature" --target "$TARGET"
           done
-      - name: crates with 'wasm' feature
+      - name: crates with 'sha1' and 'wasm' feature
         run: |
           set -x
           for crate in gix-pack; do
-            cargo build -p "$crate" --features wasm --target "$TARGET"
+            cargo build -p "$crate" --features sha1,wasm --target "$TARGET"
+          done
+      - name: crates with 'sha1' feature
+        run: |
+          crates=(
+            gix-commitgraph
+            gix-hash
+            gix-hashtable
+            gix-object
+            gix-refspec
+            gix-revision
+            gix-traverse
+          )
+          set -x
+          for crate in "${crates[@]}"; do
+            cargo build -p "$crate" --features sha1 --target "$TARGET"
           done
       - name: gix-pack with all features (including wasm)
         run: cargo build -p gix-pack --all-features --target "$TARGET"

Cargo.lock

@@ -42,7 +42,7 @@ default = ["max"]
 ##
 ## When used in conjunction with `http-client-curl-rustls`, the `openssl` crates will still be compiled, but won't be used. To bypass this, disable
 ## default dependencies and specify the features yourself.
-max = ["max-control", "fast", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-blocking-client", "http-client-curl-openssl"]
+max = ["hashes", "max-control", "fast", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-blocking-client", "http-client-curl-openssl"]
 
 ## Like `max`, but only Rust is allowed.
 ##
@@ -51,22 +51,23 @@ max = ["max-control", "fast", "gitoxide-core-tools-query", "gitoxide-core-tools-
 ## This uses Rust's HTTP implementation.
 ##
 ## 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.
-max-pure = ["max-control", "http-client-reqwest", "gitoxide-core-blocking-client"]
+max-pure = ["hashes", "max-control", "http-client-reqwest", "gitoxide-core-blocking-client"]
 
 ## Like `max`, but with more control for configuration. See the *Package Maintainers* headline for more information.
+## Needs to chose its own hash(es).
 max-control = ["tracing", "fast", "pretty-cli", "gitoxide-core-tools", "prodash-render-line", "prodash-render-tui", "prodash/render-line-autoconfigure", "gix/revparse-regex"]
 
 ## All the good stuff, with less fanciness for smaller binaries.
 ##
 ## As fast as possible, progress line rendering, all transports based on their most mature implementation (HTTP), all `ein` tools, CLI colors and local-time support, JSON output.
-lean = ["fast", "tracing", "pretty-cli", "http-client-curl-openssl", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-tools", "gitoxide-core-blocking-client", "prodash-render-line"]
+lean = ["hashes", "fast", "tracing", "pretty-cli", "http-client-curl-openssl", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-tools", "gitoxide-core-blocking-client", "prodash-render-line"]
 
 ## The smallest possible build, best suitable for small single-core machines.
 ##
 ## This build is essentially limited to local operations without any fanciness. It does not have `gix clone`.
 ##
 ## Optimized for size, no parallelism thus much slower, progress line rendering.
-small = ["pretty-cli", "prodash-render-line", "is-terminal"]
+small = ["hashes", "pretty-cli", "prodash-render-line", "is-terminal"]
 
 ## Like lean, but uses Rusts async implementations for networking.
 ##
@@ -77,7 +78,7 @@ small = ["pretty-cli", "prodash-render-line", "is-terminal"]
 ##
 ## Due to async client-networking not being implemented for most transports, this one supports only the 'git+tcp' and HTTP transport.
 ## It uses, however, a fully asynchronous networking implementation which can serve a real-world example on how to implement custom async transports.
-lean-async = ["fast", "tracing", "pretty-cli", "gitoxide-core-tools", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-async-client", "prodash-render-line"]
+lean-async = ["hashes", "fast", "tracing", "pretty-cli", "gitoxide-core-tools", "gitoxide-core-tools-query", "gitoxide-core-tools-corpus", "gitoxide-core-async-client", "prodash-render-line"]
 
 #! ### Package Maintainers
 #! `*-control` features leave it to you to configure C libraries, involving choices for HTTP transport implementation.
@@ -88,6 +89,11 @@ lean-async = ["fast", "tracing", "pretty-cli", "gitoxide-core-tools", "gitoxide-
 #! ### Building Blocks
 #! Typical combinations of features of our dependencies, some of which are referred to in the `gitoxide` crate's code for conditional compilation.
 
+## Provide support for all known hashes. If this isn't enabled, select an individual hash algorithms.
+hashes = ["sha1"]
+## Enable support for the SHA-1 hash throughout the `gix` crate.
+sha1 = ["gix/sha1"]
+
 ## Makes the crate execute as fast as possible by supporting parallel computation of otherwise long-running functions.
 ## If disabled, the binary will be visibly smaller.
 fast = ["gix/max-performance", "gix/comfort"]

Cargo.toml

@@ -95,6 +95,9 @@ open = "5.0.0"
 
 document-features = { version = "0.2.0", optional = true }
 
+[dev-dependencies]
+gix = { path = "../gix", default-features = false, features = ["sha1"] }
+
 [package.metadata.docs.rs]
 features = ["document-features", "blocking-client", "organize", "estimate-hours", "serde"]
 

gitoxide-core/Cargo.toml

@@ -16,6 +16,8 @@ doctest = false
 
 [features]
 default = ["tar", "tar_gz", "zip"]
+## Enable support for the SHA-1 hash by forwarding the feature to dependencies.
+sha1 = ["gix-worktree-stream/sha1", "gix-object/sha1"]
 
 ## Enable the `tar` archive format. It has support for all information, except for object ids.
 tar = ["dep:tar", "dep:gix-path"]
@@ -48,11 +50,11 @@ gix-odb = { path = "../gix-odb" }
 gix-worktree = { path = "../gix-worktree", default-features = false, features = [
     "attributes",
 ] }
-gix-hash = { path = "../gix-hash" }
+gix-hash = { path = "../gix-hash", features = ["sha1"] }
 gix-attributes = { path = "../gix-attributes" }
 gix-object = { path = "../gix-object" }
 gix-filter = { path = "../gix-filter" }
 
 [package.metadata.docs.rs]
 all-features = true
-features = ["document-features"]
+features = ["sha1", "document-features"]

gix-archive/Cargo.toml

@@ -10,6 +10,18 @@ authors = ["Christoph Rüßler <christoph.ruessler@mailbox.org>", "Sebastian Thi
 edition = "2021"
 rust-version = "1.82"
 
+[features]
+## Enable support for the SHA-1 hash by forwarding the feature to dependencies.
+sha1 = [
+    "gix-commitgraph/sha1",
+    "gix-diff/sha1",
+    "gix-hash/sha1",
+    "gix-object/sha1",
+    "gix-revwalk/sha1",
+    "gix-traverse/sha1",
+    "gix-worktree/sha1",
+]
+
 [dependencies]
 gix-error = { version = "^0.2.0", path = "../gix-error" }
 gix-commitgraph = { version = "^0.34.0", path = "../gix-commitgraph" }
@@ -33,3 +45,6 @@ gix-index = { path = "../gix-index" }
 gix-odb = { path = "../gix-odb" }
 gix-testtools = { path = "../tests/tools" }
 pretty_assertions = "1.4.0"
+
+[package.metadata.docs.rs]
+features = ["sha1"]

gix-blame/Cargo.toml

@@ -16,6 +16,8 @@ rust-version = "1.82"
 doctest = false
 
 [features]
+## Enable support for the SHA-1 hash by enabling the respective feature in the `gix-hash` crate.
+sha1 = ["gix-hash/sha1"]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`
 serde = ["dep:serde", "gix-hash/serde", "bstr/serde"]
 
@@ -34,11 +36,11 @@ document-features = { version = "0.2.0", optional = true }
 [dev-dependencies]
 gix-testtools = { path = "../tests/tools" }
 gix-date = { path = "../gix-date" }
-gix-hash = { path = "../gix-hash", features = ["sha256"] }
+gix-hash = { path = "../gix-hash", features = ["sha1", "sha256"] }
 
 [package.metadata.docs.rs]
 all-features = true
-features = ["document-features"]
+features = ["sha1", "document-features"]
 
 [package.metadata.cargo-machete]
 ignored = [

gix-commitgraph/Cargo.toml

@@ -21,6 +21,7 @@ memmap2 = "0.9.0"
 
 [dependencies.gix-commitgraph]
 path = ".."
+features = ["sha1"]
 
 # Prevent this from interfering with workspaces
 [workspace]

gix-commitgraph/fuzz/Cargo.toml

@@ -15,6 +15,8 @@ rust-version = "1.82"
 autotests = false
 
 [features]
+## Enable support for the SHA-1 hash by forwarding the feature to dependencies.
+sha1 = ["gix-ref/sha1"]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde = ["dep:serde", "bstr/serde", "gix-sec/serde", "gix-ref/serde", "gix-glob/serde", "gix-config-value/serde"]
 
@@ -38,6 +40,7 @@ document-features = { version = "0.2.0", optional = true }
 
 [dev-dependencies]
 criterion = "0.8.0"
+gix-config = { path = ".", features = ["sha1"] }
 
 [[bench]]
 name = "large_config_file"
@@ -46,7 +49,7 @@ path = "./benches/large_config_file.rs"
 
 [package.metadata.docs.rs]
 all-features = true
-features = ["document-features"]
+features = ["sha1", "document-features"]
 
 [package.metadata.cargo-machete]
 ignored = [

gix-config/Cargo.toml

@@ -16,6 +16,7 @@ anyhow = "1.0.76"
 
 [dependencies.gix-config]
 path = ".."
+features = ["sha1"]
 
 # Prevent this from interfering with workspaces
 [workspace]