Merge branch 'check-cfg'

GitoxideLabs · Nov 19, 2023 · 5a0d93e · 5a0d93e
2 parents 2b80d84 + fc23775
commit 5a0d93e
Show file tree

Hide file tree

Showing 67 changed files with 103 additions and 148 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -172,7 +172,7 @@ jobs:
           # Let's not fail CI for this, it will fail locally often enough, and a crate a little bigger
           # than allows is no problem either if it comes to that.
           just check-size || true
-
+  
   cargo-deny:
     runs-on: ubuntu-latest
     strategy:

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -302,4 +302,3 @@ prodash = { version = "26.2.2", default-features = false }
 
 [package.metadata.docs.rs]
 features = ["document-features", "max"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gitoxide-core/Cargo.toml b/gitoxide-core/Cargo.toml
@@ -93,4 +93,3 @@ document-features = { version = "0.2.0", optional = true }
 
 [package.metadata.docs.rs]
 features = ["document-features", "blocking-client", "organize", "estimate-hours", "serde"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gitoxide-core/src/lib.rs b/gitoxide-core/src/lib.rs
@@ -22,10 +22,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![cfg_attr(feature = "async-client", allow(unused))]
 #![deny(rust_2018_idioms)]
 #![forbid(unsafe_code)]

diff --git a/gix-actor/Cargo.toml b/gix-actor/Cargo.toml
@@ -37,4 +37,3 @@ gix-hash = { path = "../gix-hash" }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-actor/src/lib.rs b/gix-actor/src/lib.rs
@@ -2,10 +2,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-archive/Cargo.toml b/gix-archive/Cargo.toml
@@ -53,4 +53,3 @@ gix-filter = { path = "../gix-filter"}
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-archive/src/lib.rs b/gix-archive/src/lib.rs
@@ -9,10 +9,10 @@
 //! ## Feature Flags
 //! All features are related to which container formats are available.
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(rust_2018_idioms, missing_docs)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-attributes/Cargo.toml b/gix-attributes/Cargo.toml
@@ -37,5 +37,4 @@ gix-fs = { path = "../gix-fs" }
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
 features = ["document-features"]
diff --git a/gix-attributes/src/lib.rs b/gix-attributes/src/lib.rs
@@ -2,10 +2,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 pub use gix_glob as glob;

diff --git a/gix-commitgraph/Cargo.toml b/gix-commitgraph/Cargo.toml
@@ -36,4 +36,3 @@ gix-date = { path = "../gix-date" }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-commitgraph/src/lib.rs b/gix-commitgraph/src/lib.rs
@@ -9,10 +9,10 @@
 //! Eventually, git will merge these files together as the number of files grows.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 use std::path::Path;

diff --git a/gix-config-value/Cargo.toml b/gix-config-value/Cargo.toml
@@ -32,4 +32,3 @@ libc = "0.2"
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-config-value/src/lib.rs b/gix-config-value/src/lib.rs
@@ -2,10 +2,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 /// The error returned when any config value couldn't be instantiated due to malformed input.

diff --git a/gix-config/Cargo.toml b/gix-config/Cargo.toml
@@ -46,4 +46,3 @@ path = "./benches/large_config_file.rs"
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-config/src/lib.rs b/gix-config/src/lib.rs
@@ -31,10 +31,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 pub mod file;

diff --git a/gix-credentials/Cargo.toml b/gix-credentials/Cargo.toml
@@ -40,4 +40,3 @@ gix-sec = { path = "../gix-sec" }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-credentials/src/lib.rs b/gix-credentials/src/lib.rs
@@ -2,10 +2,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-date/Cargo.toml b/gix-date/Cargo.toml
@@ -33,4 +33,3 @@ gix-hash = { path = "../gix-hash" }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-date/src/lib.rs b/gix-date/src/lib.rs
@@ -3,10 +3,10 @@
 //! Note that this is not a general purpose time library.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-diff/Cargo.toml b/gix-diff/Cargo.toml
@@ -37,4 +37,3 @@ document-features = { version = "0.2.0", optional = true }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-diff/src/lib.rs b/gix-diff/src/lib.rs
@@ -1,10 +1,10 @@
 //! Algorithms for diffing various git object types and for generating patches, highly optimized for performance.
 //! ## Feature Flags
 #![cfg_attr(
-feature = "document-features",
-cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-features/Cargo.toml b/gix-features/Cargo.toml
@@ -159,4 +159,3 @@ sha1 = { version = "0.10.0", optional = true, features = ["asm"] }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-features/src/lib.rs b/gix-features/src/lib.rs
@@ -8,10 +8,10 @@
 //! counterparts with higher performance.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 ///

diff --git a/gix-fs/Cargo.toml b/gix-fs/Cargo.toml
@@ -12,8 +12,13 @@ include = ["src/**/*", "LICENSE-*"]
 [lib]
 doctest = false
 
+[features]
+## Data structures implement `serde::Serialize` and `serde::Deserialize`.
+serde = ["dep:serde"]
+
 [dependencies]
 gix-features = { version = "^0.36.0", path = "../gix-features" }
+serde = { version = "1.0.114", optional = true, default-features = false, features = ["std", "derive"] }
 
 [dev-dependencies]
 tempfile = "3.5.0"
diff --git a/gix-glob/Cargo.toml b/gix-glob/Cargo.toml
@@ -31,4 +31,3 @@ gix-testtools = { path = "../tests/tools"}
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-glob/src/lib.rs b/gix-glob/src/lib.rs
@@ -1,10 +1,10 @@
 //! Provide glob [`Patterns`][Pattern] for matching against paths or anything else.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-hash/Cargo.toml b/gix-hash/Cargo.toml
@@ -31,4 +31,3 @@ gix-features = { path = "../gix-features", features = ["rustsha1"] }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-hash/src/lib.rs b/gix-hash/src/lib.rs
@@ -3,10 +3,10 @@
 //! These are provided in [borrowed versions][oid] as well as an [owned one][ObjectId].
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 #[path = "oid.rs"]

diff --git a/gix-ignore/Cargo.toml b/gix-ignore/Cargo.toml
@@ -32,5 +32,4 @@ gix-fs = { path = "../gix-fs" }
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
 features = ["document-features"]
diff --git a/gix-ignore/src/lib.rs b/gix-ignore/src/lib.rs
@@ -2,10 +2,10 @@
 //!
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-index/Cargo.toml b/gix-index/Cargo.toml
@@ -47,4 +47,3 @@ libc = { version = "0.2.149" }
 
 [package.metadata.docs.rs]
 features = ["document-features", "serde"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-index/src/lib.rs b/gix-index/src/lib.rs
@@ -1,9 +1,9 @@
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(unsafe_code, missing_docs, rust_2018_idioms)]
 
 use std::{ops::Range, path::PathBuf};

diff --git a/gix-mailmap/Cargo.toml b/gix-mailmap/Cargo.toml
@@ -31,4 +31,3 @@ gix-testtools = { path = "../tests/tools"}
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-mailmap/src/lib.rs b/gix-mailmap/src/lib.rs
@@ -2,10 +2,10 @@
 //! using an [accelerated data-structure][Snapshot].
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-object/Cargo.toml b/gix-object/Cargo.toml
@@ -52,5 +52,4 @@ gix-testtools = { path = "../tests/tools"}
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
-rustdoc-args = ["--cfg", "docsrs"]
 
diff --git a/gix-object/src/lib.rs b/gix-object/src/lib.rs
@@ -2,10 +2,10 @@
 //! as well as [mutable versions][Object] of these. Both types of objects can be encoded.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/gix-odb/Cargo.toml b/gix-odb/Cargo.toml
@@ -44,4 +44,3 @@ document-features = { version = "0.2.0", optional = true }
 
 [package.metadata.docs.rs]
 features = ["document-features", "serde"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-odb/src/lib.rs b/gix-odb/src/lib.rs
@@ -9,10 +9,10 @@
 //! * multiple loose objects and pack locations as gathered from `alternates` files.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 use std::{

diff --git a/gix-pack/Cargo.toml b/gix-pack/Cargo.toml
@@ -66,4 +66,3 @@ gix-testtools = { path = "../tests/tools"}
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features", "pack-cache-lru-dynamic", "object-cache-dynamic", "serde"]
-rustdoc-args = ["--cfg", "docsrs"]
diff --git a/gix-pack/src/lib.rs b/gix-pack/src/lib.rs
@@ -12,10 +12,10 @@
 //! in order to decompress packs in parallel and without any waste.
 //! ## Feature Flags
 #![cfg_attr(
-    feature = "document-features",
-    cfg_attr(doc, doc = ::document_features::document_features!())
+    all(doc, feature = "document-features"),
+    doc = ::document_features::document_features!()
 )]
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(all(doc, feature = "document-features"), feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 ///