Rename docsrs flag to rune_docs (relates tokio-rs/tokio#6165)

bernsteining · Nov 28, 2023 · 8e2a0d2 · 8e2a0d2
1 parent e309b3e
commit 8e2a0d2
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -41,8 +41,8 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - run: cargo doc -p rune --all-features
       env:
-        RUSTFLAGS: --cfg docsrs
-        RUSTDOCFLAGS: --cfg docsrs
+        RUSTFLAGS: --cfg rune_docsrs
+        RUSTDOCFLAGS: --cfg rune_docsrs
 
   basics:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/site.yml b/.github/workflows/site.yml
@@ -32,8 +32,8 @@ jobs:
     - run: cargo +nightly doc -p rune --all-features
       env:
         RUST_LOG: rune=info
-        RUSTFLAGS: --cfg docsrs
-        RUSTDOCFLAGS: --cfg docsrs
+        RUSTFLAGS: --cfg rune_docsrs
+        RUSTDOCFLAGS: --cfg rune_docsrs
     - run: mv target/doc target/site/api
     - uses: peaceiris/actions-gh-pages@v3
       with:

diff --git a/crates/rune/Cargo.toml b/crates/rune/Cargo.toml
@@ -81,4 +81,4 @@ trybuild = "1.0.80"
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "rune_docsrs"]
diff --git a/crates/rune/src/internal_macros.rs b/crates/rune/src/internal_macros.rs
@@ -75,7 +75,7 @@ macro_rules! cfg_emit {
     ($($item:item)*) => {
         $(
             #[cfg(feature = "emit")]
-            #[cfg_attr(docsrs, doc(cfg(feature = "emit")))]
+            #[cfg_attr(rune_docsrs, doc(cfg(feature = "emit")))]
             $item
         )*
     }
@@ -85,7 +85,7 @@ macro_rules! cfg_workspace {
     ($($item:item)*) => {
         $(
             #[cfg(feature = "workspace")]
-            #[cfg_attr(docsrs, doc(cfg(feature = "workspace")))]
+            #[cfg_attr(rune_docsrs, doc(cfg(feature = "workspace")))]
             $item
         )*
     }
@@ -95,7 +95,7 @@ macro_rules! cfg_cli {
     ($($item:item)*) => {
         $(
             #[cfg(feature = "cli")]
-            #[cfg_attr(docsrs, doc(cfg(feature = "cli")))]
+            #[cfg_attr(rune_docsrs, doc(cfg(feature = "cli")))]
             $item
         )*
     }
@@ -105,7 +105,7 @@ macro_rules! cfg_doc {
     ($($item:item)*) => {
         $(
             #[cfg(feature = "doc")]
-            #[cfg_attr(docsrs, doc(cfg(feature = "doc")))]
+            #[cfg_attr(rune_docsrs, doc(cfg(feature = "doc")))]
             $item
         )*
     }
@@ -115,7 +115,7 @@ macro_rules! cfg_std {
     ($($item:item)*) => {
         $(
             #[cfg(feature = "std")]
-            #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+            #[cfg_attr(rune_docsrs, doc(cfg(feature = "std")))]
             $item
         )*
     }

diff --git a/crates/rune/src/lib.rs b/crates/rune/src/lib.rs
@@ -141,7 +141,7 @@
 #![allow(clippy::type_complexity)]
 #![allow(clippy::module_inception)]
 #![allow(clippy::self_named_constructors)]
-#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(rune_docsrs, feature(doc_cfg))]
 
 #[cfg(feature = "std")]
 #[macro_use]