Avoid use of docsrs cfg

ctz · djc · commit 31ca6afe9165 · 2025-10-22T06:23:57.000Z
cfg is a global namespace, and we don't want to trigger this in
dependencies.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -41,7 +41,7 @@ jobs:
         # keep features in sync with Cargo.toml `[package.metadata.docs.rs]` section
         run: cargo doc --locked --features read_buf,ring --no-deps --package rustls
         env:
-          RUSTDOCFLAGS: -Dwarnings --cfg=docsrs --html-after-content tag.html
+          RUSTDOCFLAGS: -Dwarnings --cfg=rustls_docsrs --html-after-content tag.html
 
       - name: Generate other pages
         run: |
diff --git a/rustls/Cargo.toml b/rustls/Cargo.toml
@@ -114,7 +114,7 @@ path = "tests/runners/unbuffered.rs"
 [package.metadata.docs.rs]
 # all non-default features except fips (cannot build on docs.rs environment)
 features = ["read_buf", "ring"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "rustls_docsrs"]
 
 [package.metadata.cargo_check_external_types]
 allowed_external_types = [
@@ -127,4 +127,9 @@ allowed_external_types = [
 enum_no_repr_variant_discriminant_changed = "warn"
 
 [lints.rust]
-unexpected_cfgs = { level = "warn", check-cfg = ["cfg(bench)", "cfg(coverage_nightly)", "cfg(read_buf)"] }
+unexpected_cfgs = { level = "warn", check-cfg = [
+  "cfg(bench)",
+  "cfg(coverage_nightly)",
+  "cfg(read_buf)",
+  "cfg(rustls_docsrs)",
+] }
diff --git a/rustls/src/crypto/mod.rs b/rustls/src/crypto/mod.rs
@@ -690,8 +690,8 @@ impl From<Vec<u8>> for SharedSecret {
 ///     .with_no_client_auth();
 /// # }
 /// ```
-#[cfg(all(feature = "aws_lc_rs", any(feature = "fips", docsrs)))]
-#[cfg_attr(docsrs, doc(cfg(feature = "fips")))]
+#[cfg(all(feature = "aws_lc_rs", any(feature = "fips", rustls_docsrs)))]
+#[cfg_attr(rustls_docsrs, doc(cfg(feature = "fips")))]
 pub fn default_fips_provider() -> CryptoProvider {
     aws_lc_rs::default_provider()
 }
diff --git a/rustls/src/lib.rs b/rustls/src/lib.rs
@@ -364,7 +364,7 @@
     clippy::new_without_default
 )]
 // Enable documentation for all features on docs.rs
-#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+#![cfg_attr(rustls_docsrs, feature(doc_cfg, doc_auto_cfg))]
 // Enable coverage() attr for nightly coverage builds, see
 // <https://github.com/rust-lang/rust/issues/84605>
 // (`coverage_nightly` is a cfg set by `cargo-llvm-cov`)
