feat: use docsrs feature in code to show what is feature-gated automa…

…tically on docs.rs
GitoxideLabs · Aug 19, 2022 · b1c40b0 · b1c40b0
1 parent f7f136d
commit b1c40b0
Show file tree

Hide file tree

Showing 26 changed files with 27 additions and 0 deletions.
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)]
+
 use bstr::{BStr, BString};
 pub use git_date::{time::Sign, Time};
 

diff --git a/git-attributes/src/lib.rs b/git-attributes/src/lib.rs
@@ -5,6 +5,7 @@
     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)]
 

diff --git a/git-commitgraph/src/lib.rs b/git-commitgraph/src/lib.rs
@@ -12,6 +12,7 @@
     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-config/src/lib.rs b/git-config/src/lib.rs
@@ -34,6 +34,7 @@
     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/src/lib.rs b/git-credentials/src/lib.rs
@@ -5,6 +5,7 @@
     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)]
 

diff --git a/git-date/src/lib.rs b/git-date/src/lib.rs
@@ -6,6 +6,7 @@
     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)]
 

diff --git a/git-features/src/lib.rs b/git-features/src/lib.rs
@@ -11,6 +11,7 @@
     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)]
 
 ///

diff --git a/git-glob/src/lib.rs b/git-glob/src/lib.rs
@@ -4,6 +4,7 @@
     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)]
 

diff --git a/git-hash/src/lib.rs b/git-hash/src/lib.rs
@@ -6,6 +6,7 @@
     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)]
 
 mod borrowed;

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-mailmap/src/lib.rs b/git-mailmap/src/lib.rs
@@ -5,6 +5,7 @@
     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)]
 

diff --git a/git-object/src/lib.rs b/git-object/src/lib.rs
@@ -5,6 +5,7 @@
     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)]
 

diff --git a/git-odb/src/lib.rs b/git-odb/src/lib.rs
@@ -12,6 +12,7 @@
     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)]
 
 use std::{

diff --git a/git-pack/src/lib.rs b/git-pack/src/lib.rs
@@ -15,6 +15,7 @@
     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)]
 
 ///

diff --git a/git-packetline/src/lib.rs b/git-packetline/src/lib.rs
@@ -6,6 +6,7 @@
     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)]
 
 const U16_HEX_BYTES: usize = 4;

diff --git a/git-protocol/src/lib.rs b/git-protocol/src/lib.rs
@@ -7,6 +7,7 @@
     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 use git_credentials as credentials;

diff --git a/git-ref/src/lib.rs b/git-ref/src/lib.rs
@@ -20,6 +20,7 @@
     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)]
 
 use std::borrow::Cow;

diff --git a/git-repository/src/lib.rs b/git-repository/src/lib.rs
@@ -120,6 +120,7 @@
     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)]
 
 // Re-exports to make this a potential one-stop shop crate avoiding people from having to reference various crates themselves.

diff --git a/git-revision/src/lib.rs b/git-revision/src/lib.rs
@@ -5,6 +5,7 @@
     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)]
 
 /// Access to collections optimized for keys that are already a hash.

diff --git a/git-sec/src/lib.rs b/git-sec/src/lib.rs
@@ -5,6 +5,7 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 // `unsafe_code` not forbidden because we need to interact with the libc
 #![deny(missing_docs, rust_2018_idioms, unsafe_code)]
 

diff --git a/git-transport/src/lib.rs b/git-transport/src/lib.rs
@@ -7,6 +7,7 @@
     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)]
 

diff --git a/git-url/src/lib.rs b/git-url/src/lib.rs
@@ -4,6 +4,7 @@
     feature = "document-features",
     cfg_attr(doc, doc = ::document_features::document_features!())
 )]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 #![deny(rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/git-worktree/src/lib.rs b/git-worktree/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(missing_docs, rust_2018_idioms, unsafe_code)]
 
 /// file system related utilities

diff --git a/gitoxide-core/src/lib.rs b/gitoxide-core/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))]
 #![cfg_attr(feature = "async-client", allow(unused))]
 #![deny(rust_2018_idioms)]
 #![forbid(unsafe_code)]

diff --git a/src/ein.rs b/src/ein.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(rust_2018_idioms)]
 #![forbid(unsafe_code)]
 

diff --git a/src/gix.rs b/src/gix.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(rust_2018_idioms)]
 #![forbid(unsafe_code)]