document-features support for git-index and git-worktree (#301)

Byron · Feb 27, 2022 · f53c395 · f53c395
1 parent ecd2e5e
commit f53c395
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/git-index/Cargo.toml b/git-index/Cargo.toml
@@ -46,5 +46,11 @@ smallvec = "1.7.0"
 atoi = "1.0.0"
 bitflags = "1.3.2"
 
+document-features = { version = "0.2.0", optional = true }
+
 [dev-dependencies]
 git-testtools = { path = "../tests/tools"}
+
+[package.metadata.docs.rs]
+features = ["document-features", "serde1"]
+
diff --git a/git-index/src/lib.rs b/git-index/src/lib.rs
@@ -1,3 +1,8 @@
+//! ## Feature Flags
+#![cfg_attr(
+    feature = "document-features",
+    cfg_attr(doc, doc = ::document_features::document_features!())
+)]
 #![deny(unsafe_code, missing_docs, rust_2018_idioms)]
 #![allow(missing_docs)]
 

diff --git a/git-worktree/Cargo.toml b/git-worktree/Cargo.toml
@@ -37,5 +37,4 @@ walkdir = "2.3.2"
 tempfile = "3.2.0"
 
 [package.metadata.docs.rs]
-features = ["document-features"]
-all-features = true
+features = ["document-features", "serde1"]
diff --git a/git-worktree/src/lib.rs b/git-worktree/src/lib.rs
@@ -1,3 +1,8 @@
+//! ## Feature Flags
+#![cfg_attr(
+    feature = "document-features",
+    cfg_attr(doc, doc = ::document_features::document_features!())
+)]
 #![forbid(unsafe_code, rust_2018_idioms)]
 
 /// file system related utilities