Merge branch 'docsrs-show-features'

GitoxideLabs · Aug 20, 2022 · 31c2351 · 31c2351
2 parents df62f50 + b1c40b0
commit 31c2351
Show file tree

Hide file tree

Showing 94 changed files with 154 additions and 161 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,14 +10,12 @@ default-run = "gix"
 include = ["src/**/*", "LICENSE-*", "README.md", "CHANGELOG.md"]
 resolver = "2"
 
-
 [[bin]]
 name = "ein"
 path = "src/ein.rs"
 test = false
 doctest = false
 
-
 [[bin]]
 name = "gix"
 path = "src/gix.rs"
@@ -41,7 +39,6 @@ pretty-cli = [ "gitoxide-core/serde1", "prodash/progress-tree", "prodash/progres
 ## that appears after a short duration.
 prodash-render-line-crossterm = ["prodash-render-line", "prodash/render-line-crossterm", "atty", "crosstermion"]
 
-
 #! ### Convenience Features
 #! These combine common choices of the above features to represent typical builds
 
@@ -183,3 +180,4 @@ exclude = ["cargo-smart-release/tests/fixtures/tri-depth-workspace/a",
 
 [package.metadata.docs.rs]
 features = ["document-features", "max"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/cargo-smart-release/Cargo.toml b/cargo-smart-release/Cargo.toml
@@ -10,8 +10,6 @@ categories = ["development-tools::cargo-plugins"]
 keywords = ["cargo"]
 include = ["src/**/*", "README.md", "CHANGELOG.md"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [[bin]]
 name = "cargo-smart-release"
 path = "src/cli/main-smart-release.rs"

diff --git a/git-actor/Cargo.toml b/git-actor/Cargo.toml
@@ -33,5 +33,6 @@ pretty_assertions = "1.0.0"
 git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-actor/src/lib.rs b/git-actor/src/lib.rs
@@ -5,8 +5,10 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
-#![deny(rust_2018_idioms, missing_docs)]
+
 use bstr::{BStr, BString};
 pub use git_date::{time::Sign, Time};
 

diff --git a/git-attributes/Cargo.toml b/git-attributes/Cargo.toml
@@ -15,8 +15,6 @@ doctest = false
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1", "git-glob/serde1", "compact_str/serde"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 git-features = { version = "^0.22.1", path = "../git-features" }
 git-path = { version = "^0.4.0", path = "../git-path" }
@@ -36,4 +34,5 @@ git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
 all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
 features = ["document-features"]
diff --git a/git-attributes/src/lib.rs b/git-attributes/src/lib.rs
@@ -5,8 +5,9 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
-#![deny(rust_2018_idioms, missing_docs)]
 
 use std::path::PathBuf;
 

diff --git a/git-bitmap/Cargo.toml b/git-bitmap/Cargo.toml
@@ -11,8 +11,6 @@ edition = "2018"
 doctest = false
 test = true
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 quick-error = "2.0.0"
 

diff --git a/git-bitmap/src/lib.rs b/git-bitmap/src/lib.rs
@@ -1,8 +1,8 @@
-#![deny(unsafe_code, missing_docs, rust_2018_idioms)]
-#![allow(missing_docs)]
 //! An implementation of the shared parts of git bitmaps used in `git-pack`, `git-index` and `git-worktree`.
 //!
 //! Note that many tests are performed indirectly by tests in the aforementioned consumer crates.
+#![deny(rust_2018_idioms, unsafe_code)]
+#![allow(missing_docs)]
 
 /// Bitmap utilities for the advanced word-aligned hybrid bitmap
 pub mod ewah;

diff --git a/git-chunk/src/lib.rs b/git-chunk/src/lib.rs
@@ -1,8 +1,7 @@
 //! Low-level access to reading and writing chunk file based formats.
 //!
 //! See the [git documentation](https://github.com/git/git/blob/seen/Documentation/technical/chunk-format.txt) for details.
-#![deny(unsafe_code)]
-#![deny(rust_2018_idioms, missing_docs)]
+#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 /// An identifier to describe the kind of chunk, unique within a chunk file, typically in ASCII
 pub type Id = [u8; 4];

diff --git a/git-commitgraph/Cargo.toml b/git-commitgraph/Cargo.toml
@@ -32,5 +32,6 @@ document-features = { version = "0.2.0", optional = true }
 git-testtools = { path = "../tests/tools" }
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-commitgraph/src/lib.rs b/git-commitgraph/src/lib.rs
@@ -12,7 +12,8 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
-#![deny(unsafe_code, rust_2018_idioms, missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 pub mod file;
 pub mod graph;

diff --git a/git-config/Cargo.toml b/git-config/Cargo.toml
@@ -49,5 +49,6 @@ harness = false
 path = "./benches/large_config_file.rs"
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-config/src/lib.rs b/git-config/src/lib.rs
@@ -1,5 +1,3 @@
-#![deny(missing_docs, unsafe_code, rust_2018_idioms)]
-
 //! # `git_config`
 //!
 //! This crate is a high performance `git-config` file reader and writer. It
@@ -36,6 +34,8 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 pub mod file;
 

diff --git a/git-credentials/Cargo.toml b/git-credentials/Cargo.toml
@@ -14,8 +14,6 @@ doctest = false
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1", "git-sec/serde1"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 git-sec = { version = "^0.3.0", path = "../git-sec" }
 quick-error = "2.0.0"
@@ -27,3 +25,4 @@ document-features = { version = "0.2.1", optional = true }
 [package.metadata.docs.rs]
 all-features = true
 features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-credentials/src/lib.rs b/git-credentials/src/lib.rs
@@ -5,8 +5,9 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
-#![forbid(unsafe_code)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
+#![forbid(unsafe_code)]
 
 ///
 pub mod helper;

diff --git a/git-date/Cargo.toml b/git-date/Cargo.toml
@@ -10,8 +10,6 @@ edition = "2018"
 [lib]
 doctest = false
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [features]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1"]
@@ -28,5 +26,6 @@ document-features = { version = "0.2.0", optional = true }
 git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-date/src/lib.rs b/git-date/src/lib.rs
@@ -6,8 +6,9 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
-#![forbid(unsafe_code)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(missing_docs, rust_2018_idioms)]
+#![forbid(unsafe_code)]
 
 ///
 pub mod time;

diff --git a/git-diff/Cargo.toml b/git-diff/Cargo.toml
@@ -11,8 +11,6 @@ include = ["src/**/*"]
 [lib]
 doctest = false
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 git-hash = { version = "^0.9.7", path = "../git-hash" }
 git-object = { version = "^0.20.1", path = "../git-object" }

diff --git a/git-diff/src/lib.rs b/git-diff/src/lib.rs
@@ -1,6 +1,6 @@
 //! Algorithms for diffing various git object types and for generating patches, highly optimized for performance.
-#![forbid(unsafe_code, rust_2018_idioms)]
-#[deny(missing_docs)]
+#![deny(missing_docs, rust_2018_idioms)]
+#![forbid(unsafe_code)]
 
 ///
 pub mod tree;
diff --git a/git-discover/Cargo.toml b/git-discover/Cargo.toml
@@ -11,8 +11,6 @@ include = ["src/**/*", "CHANGELOG.md"]
 [lib]
 doctest = false
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 git-sec = { version = "^0.3.0", path = "../git-sec", features = ["thiserror"] }
 git-path = { version = "^0.4.0", path = "../git-path" }

diff --git a/git-discover/src/lib.rs b/git-discover/src/lib.rs
@@ -1,8 +1,8 @@
 //! Find git repositories or search them upwards from a starting point, or determine if a directory looks like a git repository.
 //!
 //! Note that detection methods are educated guesses using the presence of files, without looking too much into the details.
-#![forbid(unsafe_code, rust_2018_idioms)]
-#![deny(missing_docs)]
+#![deny(missing_docs, rust_2018_idioms)]
+#![forbid(unsafe_code)]
 
 /// The name of the `.git` directory.
 pub const DOT_GIT_DIR: &str = ".git";

diff --git a/git-features/Cargo.toml b/git-features/Cargo.toml
@@ -19,7 +19,7 @@ default = []
 progress = ["prodash"]
 
 ## If set, and with the `parallel` feature set, walkdir iterators will be single-threaded.
-## This feature exists to avoid [certain side-effects](https://github.com/starship/starship/issues/4251) of rayong threadpool configuration with `jwalk`.
+## This feature exists to avoid [certain side-effects](https://github.com/starship/starship/issues/4251) of rayon threadpool configuration with `jwalk`.
 fs-walkdir-single-threaded = []
 
 ## Use scoped threads and channels to parallelize common workloads on multiple objects. If enabled, it is used everywhere
@@ -131,12 +131,14 @@ libc = { version = "0.2.119" }
 [dev-dependencies]
 bstr = { version = "0.2.15", default-features = false }
 
-[package.metadata.docs.rs]
-features = ["document-features"]
-all-features = true
 
 # Assembly doesn't yet compile on MSVC on windows, but does on GNU, see https://github.com/RustCrypto/asm-hashes/issues/17
 # TODO: potentially include it only for certain architectures
 # [target.'cfg(all(any(target_arch = "x86", target_arch = "x86_64"), not(target_env = "msvc")))'.dependencies]
 [target.'cfg(not(target_env = "msvc"))'.dependencies]
 sha-1 = { 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/git-features/src/lib.rs b/git-features/src/lib.rs
@@ -1,5 +1,3 @@
-#![forbid(rust_2018_idioms)]
-#![deny(unsafe_code, missing_docs)]
 //! A crate providing foundational capabilities to other `git-*` crates with trade-offs between compile time, binary size or speed
 //! selectable using cargo feature toggles.
 //!
@@ -13,6 +11,8 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 ///
 pub mod cache;

diff --git a/git-filter/Cargo.toml b/git-filter/Cargo.toml
@@ -10,6 +10,4 @@ edition = "2018"
 [lib]
 doctest = false
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
diff --git a/git-filter/src/lib.rs b/git-filter/src/lib.rs
@@ -1 +1,2 @@
-#![forbid(unsafe_code, rust_2018_idioms)]
+#![deny(rust_2018_idioms)]
+#![forbid(unsafe_code)]
diff --git a/git-glob/Cargo.toml b/git-glob/Cargo.toml
@@ -14,8 +14,6 @@ doctest = false
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 bstr = { version = "0.2.13", default-features = false, features = ["std"]}
 bitflags = "1.3.2"
@@ -27,5 +25,6 @@ document-features = { version = "0.2.0", optional = true }
 git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-glob/src/lib.rs b/git-glob/src/lib.rs
@@ -4,8 +4,9 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms)]
 #![forbid(unsafe_code)]
-#![deny(rust_2018_idioms, missing_docs)]
 
 use bstr::BString;
 

diff --git a/git-hash/Cargo.toml b/git-hash/Cargo.toml
@@ -27,5 +27,6 @@ document-features = { version = "0.2.0", optional = true }
 git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
-features = ["document-features"]
 all-features = true
+features = ["document-features"]
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-hash/src/lib.rs b/git-hash/src/lib.rs
@@ -3,11 +3,11 @@
 //! These are provided in borrowed versions as well as owned ones.
 //! ## Feature Flags
 #![cfg_attr(
-feature = "document-features",
-cfg_attr(doc, doc = ::document_features::document_features!())
+    feature = "document-features",
+    cfg_attr(doc, doc = ::document_features::document_features!())
 )]
-#![deny(unsafe_code)]
-#![deny(rust_2018_idioms, missing_docs)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 
 mod borrowed;
 

diff --git a/git-index/Cargo.toml b/git-index/Cargo.toml
@@ -29,8 +29,6 @@ serde1 = ["serde", "smallvec/serde", "git-hash/serde1"]
 internal-testing-git-features-parallel = ["git-features/parallel"]
 internal-testing-to-avoid-being-run-by-cargo-test-all = []
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 git-features = { version = "^0.22.1", path = "../git-features", features = ["rustsha1", "progress"] }
 git-hash = { version = "^0.9.7", path = "../git-hash" }
@@ -55,4 +53,4 @@ git-testtools = { path = "../tests/tools"}
 
 [package.metadata.docs.rs]
 features = ["document-features", "serde1"]
-
+rustdoc-args = ["--cfg", "docsrs"]
diff --git a/git-index/src/lib.rs b/git-index/src/lib.rs
@@ -3,6 +3,7 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(unsafe_code, missing_docs, rust_2018_idioms)]
 
 use std::{ops::Range, path::PathBuf};

diff --git a/git-lfs/Cargo.toml b/git-lfs/Cargo.toml
@@ -10,6 +10,4 @@ edition = "2018"
 [lib]
 doctest = false
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
diff --git a/git-lfs/src/lib.rs b/git-lfs/src/lib.rs
@@ -1 +1,2 @@
-#![forbid(unsafe_code, rust_2018_idioms)]
+#![deny(rust_2018_idioms)]
+#![forbid(unsafe_code)]