Add doc(auto_cfg) and doc(no_auto_cfg) attributes

Author: GuillaumeGomez

compiler/rustc_error_messages/locales/en-US/passes.ftl

@@ -75,6 +75,12 @@ passes_doc_alias_not_string_literal = `#[doc(alias("a"))]` expects string litera
 passes_doc_alias_malformed =
     doc alias attribute expects a string `#[doc(alias = "a")]` or a list of strings `#[doc(alias("a", "b"))]`
 
+passes_doc_auto_cfg_malformed = `#![doc({$attr_str})]` attribute doesn't expect a value
+
+passes_doc_no_auto_cfg_enabled_by_default = `doc(no_auto_cfg)` is enabled by default before the 2024 edition
+
+passes_doc_auto_cfg_enabled_by_default = `doc(auto_cfg)` is enabled by default since the 2024 edition
+
 passes_doc_keyword_empty_mod = `#[doc(keyword = "...")]` should be used on empty modules
 
 passes_doc_keyword_not_mod = `#[doc(keyword = "...")]` should be used on modules

compiler/rustc_passes/src/check_attr.rs

@@ -5,7 +5,7 @@
 //! item.
 
 use crate::errors;
-use rustc_ast::{ast, AttrStyle, Attribute, Lit, LitKind, MetaItemKind, NestedMetaItem};
+use rustc_ast::{ast, AttrStyle, Attribute, Lit, LitKind, MetaItem, MetaItemKind, NestedMetaItem};
 use rustc_data_structures::fx::FxHashMap;
 use rustc_errors::{fluent, struct_span_err, Applicability, MultiSpan};
 use rustc_expand::base::resolve_path;
@@ -25,6 +25,7 @@ use rustc_session::lint::builtin::{
     CONFLICTING_REPR_HINTS, INVALID_DOC_ATTRIBUTES, UNUSED_ATTRIBUTES,
 };
 use rustc_session::parse::feature_err;
+use rustc_span::edition::Edition;
 use rustc_span::symbol::{kw, sym, Symbol};
 use rustc_span::{Span, DUMMY_SP};
 use rustc_target::spec::abi::Abi;
@@ -945,6 +946,40 @@ impl CheckAttrVisitor<'_> {
         is_valid
     }
 
+    /// Checks that `doc(auto_cfg)` is valid (i.e. no value) and warn if it's used whereas the
+    /// "equivalent feature" is already enabled.
+    fn check_auto_cfg(&self, meta: &MetaItem, hir_id: HirId) -> bool {
+        let name = meta.name_or_empty();
+        let mut is_valid = true;
+        if !meta.is_word() {
+            self.tcx
+                .sess
+                .emit_err(errors::DocAutoCfgMalformed { span: meta.span, attr_str: name.as_str() });
+            is_valid = false;
+        } else if name == sym::no_auto_cfg {
+            if self.tcx.sess.edition() < Edition::Edition2024 {
+                self.tcx.emit_spanned_lint(
+                    UNUSED_ATTRIBUTES,
+                    hir_id,
+                    meta.span,
+                    errors::DocNoAutoCfgEnabledByDefault,
+                );
+                is_valid = false;
+            }
+        } else {
+            if self.tcx.sess.edition() > Edition::Edition2021 {
+                self.tcx.emit_spanned_lint(
+                    UNUSED_ATTRIBUTES,
+                    hir_id,
+                    meta.span,
+                    errors::DocAutoCfgEnabledByDefault,
+                );
+                is_valid = false;
+            }
+        }
+        is_valid
+    }
+
     /// Runs various checks on `#[doc]` attributes. Returns `true` if valid.
     ///
     /// `specified_inline` should be initialized to `None` and kept for the scope
@@ -993,6 +1028,8 @@ impl CheckAttrVisitor<'_> {
                         | sym::html_root_url
                         | sym::html_no_source
                         | sym::test
+                        | sym::auto_cfg
+                        | sym::no_auto_cfg
                             if !self.check_attr_crate_level(attr, meta, hir_id) =>
                         {
                             is_valid = false;
@@ -1010,6 +1047,11 @@ impl CheckAttrVisitor<'_> {
                             is_valid = false;
                         }
 
+                        sym::auto_cfg | sym::no_auto_cfg
+                            if !self.check_auto_cfg(i_meta, hir_id) => {
+                            is_valid = false;
+                        }
+
                         // no_default_passes: deprecated
                         // passes: deprecated
                         // plugins: removed, but rustdoc warns about it itself
@@ -1031,6 +1073,8 @@ impl CheckAttrVisitor<'_> {
                         | sym::notable_trait
                         | sym::passes
                         | sym::plugins
+                        | sym::auto_cfg
+                        | sym::no_auto_cfg
                         | sym::fake_variadic => {}
 
                         sym::test => {

compiler/rustc_passes/src/errors.rs

@@ -189,6 +189,22 @@ pub struct DocAliasMalformed {
     pub span: Span,
 }
 
+#[derive(Diagnostic)]
+#[diag(passes::doc_auto_cfg_malformed)]
+pub struct DocAutoCfgMalformed<'a> {
+    #[primary_span]
+    pub span: Span,
+    pub attr_str: &'a str,
+}
+
+#[derive(LintDiagnostic)]
+#[diag(passes::doc_auto_cfg_enabled_by_default)]
+pub struct DocAutoCfgEnabledByDefault;
+
+#[derive(LintDiagnostic)]
+#[diag(passes::doc_no_auto_cfg_enabled_by_default)]
+pub struct DocNoAutoCfgEnabledByDefault;
+
 #[derive(Diagnostic)]
 #[diag(passes::doc_keyword_empty_mod)]
 pub struct DocKeywordEmptyMod {

compiler/rustc_span/src/symbol.rs

@@ -408,6 +408,7 @@ symbols! {
         attr_literals,
         attributes,
         augmented_assignments,
+        auto_cfg,
         auto_traits,
         automatically_derived,
         avx,
@@ -1009,6 +1010,7 @@ symbols! {
         next,
         nll,
         no,
+        no_auto_cfg,
         no_builtins,
         no_core,
         no_coverage,

src/librustdoc/clean/inline.rs

@@ -318,10 +318,13 @@ pub(crate) fn merge_attrs(
             } else {
                 Attributes::from_ast(&both)
             },
-            both.cfg(cx.tcx, &cx.cache.hidden_cfg),
+            both.cfg(cx.tcx, &cx.cache.hidden_cfg, cx.cache.doc_auto_cfg_active),
         )
     } else {
-        (Attributes::from_ast(&old_attrs), old_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg))
+        (
+            Attributes::from_ast(&old_attrs),
+            old_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg, cx.cache.doc_auto_cfg_active),
+        )
     }
 }
 

src/librustdoc/clean/mod.rs

@@ -2112,7 +2112,7 @@ fn clean_extern_crate<'tcx>(
         item_id: crate_def_id.into(),
         visibility: clean_visibility(ty_vis),
         kind: Box::new(ExternCrateItem { src: orig_name }),
-        cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
+        cfg: attrs.cfg(cx.tcx, &cx.cache.hidden_cfg, cx.cache.doc_auto_cfg_active),
     }]
 }
 

src/librustdoc/clean/types.rs

@@ -463,7 +463,7 @@ impl Item {
             kind,
             Box::new(Attributes::from_ast(ast_attrs)),
             cx,
-            ast_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg),
+            ast_attrs.cfg(cx.tcx, &cx.cache.hidden_cfg, cx.cache.doc_auto_cfg_active),
         )
     }
 
@@ -838,7 +838,12 @@ pub(crate) trait AttributesExt {
 
     fn inner_docs(&self) -> bool;
 
-    fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>>;
+    fn cfg(
+        &self,
+        tcx: TyCtxt<'_>,
+        hidden_cfg: &FxHashSet<Cfg>,
+        doc_auto_cfg_active: bool,
+    ) -> Option<Arc<Cfg>>;
 }
 
 impl AttributesExt for [ast::Attribute] {
@@ -864,10 +869,14 @@ impl AttributesExt for [ast::Attribute] {
         self.iter().find(|a| a.doc_str().is_some()).map_or(true, |a| a.style == AttrStyle::Inner)
     }
 
-    fn cfg(&self, tcx: TyCtxt<'_>, hidden_cfg: &FxHashSet<Cfg>) -> Option<Arc<Cfg>> {
+    fn cfg(
+        &self,
+        tcx: TyCtxt<'_>,
+        hidden_cfg: &FxHashSet<Cfg>,
+        doc_auto_cfg_active: bool,
+    ) -> Option<Arc<Cfg>> {
         let sess = tcx.sess;
         let doc_cfg_active = tcx.features().doc_cfg;
-        let doc_auto_cfg_active = tcx.features().doc_auto_cfg;
 
         fn single<T: IntoIterator>(it: T) -> Option<T::Item> {
             let mut iter = it.into_iter();

src/librustdoc/doctest.rs

@@ -1210,7 +1210,7 @@ impl<'a, 'hir, 'tcx> HirCollector<'a, 'hir, 'tcx> {
         nested: F,
     ) {
         let ast_attrs = self.tcx.hir().attrs(hir_id);
-        if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default()) {
+        if let Some(ref cfg) = ast_attrs.cfg(self.tcx, &FxHashSet::default(), false) {
             if !cfg.matches(&self.sess.parse_sess, Some(self.sess.features_untracked())) {
                 return;
             }

src/librustdoc/formats/cache.rs

@@ -121,6 +121,8 @@ pub(crate) struct Cache {
     pub(crate) intra_doc_links: FxHashMap<ItemId, Vec<clean::ItemLink>>,
     /// Cfg that have been hidden via #![doc(cfg_hide(...))]
     pub(crate) hidden_cfg: FxHashSet<clean::cfg::Cfg>,
+    /// Whether or not the `#![doc(auto_cfg)]` attribute was used.
+    pub(crate) doc_auto_cfg_active: bool,
 }
 
 /// This struct is used to wrap the `cache` and `tcx` in order to run `DocFolder`.

src/librustdoc/html/render/print_item.rs

@@ -351,7 +351,11 @@ fn item_module(w: &mut Buffer, cx: &mut Context<'_>, item: &clean::Item, items:
                     let import_item = clean::Item {
                         item_id: import_def_id.into(),
                         attrs: import_attrs,
-                        cfg: ast_attrs.cfg(cx.tcx(), &cx.cache().hidden_cfg),
+                        cfg: ast_attrs.cfg(
+                            cx.tcx(),
+                            &cx.cache().hidden_cfg,
+                            cx.cache().doc_auto_cfg_active,
+                        ),
                         ..myitem.clone()
                     };