Skip to content

Commit 5780de3

Browse files
GuillaumeGomezGuillaumeGomez
committed
Improve code and better check doc(cfg(...)) attributes
1 parent f6f97eb commit 5780de3

File tree

13 files changed

+209
-75
lines changed

13 files changed

+209
-75
lines changed

‎compiler/rustc_ast_passes/src/feature_gate.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,7 @@ impl<'a> Visitor<'a> for PostExpansionVisitor<'a> {
183183
gate_doc!(
184184
"experimental" {
185185
cfg => doc_cfg
186+
auto_cfg => doc_cfg
186187
masked => doc_masked
187188
notable_trait => doc_notable_trait
188189
}

‎compiler/rustc_passes/messages.ftl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ passes_doc_auto_cfg_hide_show_expects_list =
159159
`#![doc(auto_cfg({$attr_name}(...)))]` expects a list of items
160160
161161
passes_doc_auto_cfg_hide_show_unexpected_item =
162-
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/values items
162+
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/value items
163163
164164
passes_doc_auto_cfg_wrong_literal =
165165
`expected boolean for #[doc(auto_cfg = ...)]`

‎compiler/rustc_passes/src/check_attr.rs‎

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1175,7 +1175,15 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
11751175
}
11761176
MetaItemKind::List(list) => {
11771177
for item in list {
1178-
let Some(attr_name) = item.name() else { continue };
1178+
let Some(attr_name) = item.name() else {
1179+
self.tcx.emit_node_span_lint(
1180+
INVALID_DOC_ATTRIBUTES,
1181+
hir_id,
1182+
meta.span,
1183+
errors::DocAutoCfgExpectsHideOrShow,
1184+
);
1185+
continue;
1186+
};
11791187
if attr_name != sym::hide && attr_name != sym::show {
11801188
self.tcx.emit_node_span_lint(
11811189
INVALID_DOC_ATTRIBUTES,
@@ -1194,6 +1202,19 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
11941202
attr_name: attr_name.as_str(),
11951203
},
11961204
);
1205+
} else if match item {
1206+
MetaItemInner::Lit(_) => true,
1207+
// We already checked above that it's not a list.
1208+
MetaItemInner::MetaItem(meta) => meta.path.segments.len() != 1,
1209+
} {
1210+
self.tcx.emit_node_span_lint(
1211+
INVALID_DOC_ATTRIBUTES,
1212+
hir_id,
1213+
item.span(),
1214+
errors::DocAutoCfgHideShowUnexpectedItem {
1215+
attr_name: attr_name.as_str(),
1216+
},
1217+
);
11971218
}
11981219
}
11991220
} else {

‎compiler/rustc_span/src/symbol.rs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1150,7 +1150,6 @@ symbols! {
11501150
hashset_iter_ty,
11511151
hexagon_target_feature,
11521152
hidden,
1153-
hidden_cfg,
11541153
hide,
11551154
hint,
11561155
homogeneous_aggregate,

‎src/librustdoc/clean/inline.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,10 @@ pub(crate) fn build_impl(
605605
});
606606
}
607607

608+
// In here, we pass an empty `CfgInfo` because the computation of `cfg` happens later, so it
609+
// doesn't matter at this point.
610+
//
611+
// We need to pass this empty `CfgInfo` because `merge_attrs` is used when computing the `cfg`.
608612
let (merged_attrs, cfg) = merge_attrs(cx, load_attrs(cx, did), attrs, &mut CfgInfo::default());
609613
trace!("merged_attrs={merged_attrs:?}");
610614

‎src/librustdoc/clean/types.rs‎

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1082,8 +1082,10 @@ fn show_hide_show_conflict_error(
10821082
diag.emit();
10831083
}
10841084

1085-
/// This function checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1086-
/// `auto_cfg(show(...))` on the same item. If so, it emits an error.
1085+
/// This functions updates the `hidden_cfg` field of the provided `cfg_info` argument.
1086+
///
1087+
/// It also checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1088+
/// `auto_cfg(show(...))` on the same item and emits an error if it's the case.
10871089
///
10881090
/// Because we go through a list of `cfg`s, we keep track of the `cfg`s we saw in `new_show_attrs`
10891091
/// and in `new_hide_attrs` arguments.
@@ -1135,6 +1137,31 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
11351137
Some(item)
11361138
}
11371139

1140+
fn check_changed_auto_active_status(
1141+
changed_auto_active_status: &mut Option<rustc_span::Span>,
1142+
attr: &ast::MetaItem,
1143+
cfg_info: &mut CfgInfo,
1144+
tcx: TyCtxt<'_>,
1145+
new_value: bool,
1146+
) -> bool {
1147+
if let Some(first_change) = changed_auto_active_status {
1148+
if cfg_info.auto_cfg_active != new_value {
1149+
tcx.sess
1150+
.dcx()
1151+
.struct_span_err(
1152+
vec![*first_change, attr.span],
1153+
"`auto_cfg` was disabled and enabled more than once on the same item",
1154+
)
1155+
.emit();
1156+
return true;
1157+
}
1158+
} else {
1159+
*changed_auto_active_status = Some(attr.span);
1160+
}
1161+
cfg_info.auto_cfg_active = new_value;
1162+
false
1163+
}
1164+
11381165
let mut new_show_attrs = FxHashMap::default();
11391166
let mut new_hide_attrs = FxHashMap::default();
11401167

@@ -1182,49 +1209,39 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
11821209
};
11831210
match &attr.kind {
11841211
MetaItemKind::Word => {
1185-
if let Some(first_change) = changed_auto_active_status {
1186-
if !cfg_info.auto_cfg_active {
1187-
tcx.sess.dcx().struct_span_err(
1188-
vec![first_change, attr.span],
1189-
"`auto_cfg` was disabled and enabled more than once on the same item",
1190-
).emit();
1191-
return None;
1192-
}
1193-
} else {
1194-
changed_auto_active_status = Some(attr.span);
1212+
if check_changed_auto_active_status(
1213+
&mut changed_auto_active_status,
1214+
attr,
1215+
cfg_info,
1216+
tcx,
1217+
true,
1218+
) {
1219+
return None;
11951220
}
1196-
cfg_info.auto_cfg_active = true;
11971221
}
11981222
MetaItemKind::NameValue(lit) => {
11991223
if let LitKind::Bool(value) = lit.kind {
1200-
if let Some(first_change) = changed_auto_active_status {
1201-
if cfg_info.auto_cfg_active != value {
1202-
tcx.sess.dcx().struct_span_err(
1203-
vec![first_change, attr.span],
1204-
"`auto_cfg` was disabled and enabled more than once on the same item",
1205-
).emit();
1206-
return None;
1207-
}
1208-
} else {
1209-
changed_auto_active_status = Some(attr.span);
1224+
if check_changed_auto_active_status(
1225+
&mut changed_auto_active_status,
1226+
attr,
1227+
cfg_info,
1228+
tcx,
1229+
value,
1230+
) {
1231+
return None;
12101232
}
1211-
cfg_info.auto_cfg_active = value;
12121233
}
12131234
}
12141235
MetaItemKind::List(sub_attrs) => {
1215-
if let Some(first_change) = changed_auto_active_status {
1216-
if !cfg_info.auto_cfg_active {
1217-
tcx.sess.dcx().struct_span_err(
1218-
vec![first_change, attr.span],
1219-
"`auto_cfg` was disabled and enabled more than once on the same item",
1220-
).emit();
1221-
return None;
1222-
}
1223-
} else {
1224-
changed_auto_active_status = Some(attr.span);
1236+
if check_changed_auto_active_status(
1237+
&mut changed_auto_active_status,
1238+
attr,
1239+
cfg_info,
1240+
tcx,
1241+
true,
1242+
) {
1243+
return None;
12251244
}
1226-
// Whatever happens next, the feature is enabled again.
1227-
cfg_info.auto_cfg_active = true;
12281245
for sub_attr in sub_attrs.iter() {
12291246
if let Some(ident) = sub_attr.ident()
12301247
&& (ident.name == sym::show || ident.name == sym::hide)

‎tests/rustdoc-ui/doc-cfg.rs‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,13 @@
88
//~^^ WARN unexpected `cfg` condition name: `bar`
99
#[doc(cfg())] //~ ERROR
1010
#[doc(cfg(foo, bar))] //~ ERROR
11+
#[doc(auto_cfg(42))] //~ ERROR
12+
#[doc(auto_cfg(hide(true)))] //~ ERROR
13+
#[doc(auto_cfg(hide(42)))] //~ ERROR
14+
#[doc(auto_cfg(hide("a")))] //~ ERROR
15+
#[doc(auto_cfg(hide(foo::bar)))] //~ ERROR
16+
// Shouldn't lint
17+
#[doc(auto_cfg(hide(windows)))]
18+
#[doc(auto_cfg(hide(feature = "windows")))]
19+
#[doc(auto_cfg(hide(foo)))]
1120
pub fn foo() {}

‎tests/rustdoc-ui/doc-cfg.stderr‎

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
1-
error: `cfg` predicate is not specified
2-
--> $DIR/doc-cfg.rs:3:7
1+
error: `only "hide" or "show" are allowed in "#[doc(auto_cfg(...))]"`
2+
--> $DIR/doc-cfg.rs:11:7
33
|
4-
LL | #[doc(cfg(), cfg(foo, bar))]
5-
| ^^^^^ help: expected syntax is: `cfg(/* predicate */)`
4+
LL | #[doc(auto_cfg(42))]
5+
| ^^^^^^^^^^^^
6+
|
7+
= note: `#[deny(invalid_doc_attributes)]` on by default
68

7-
error: multiple `cfg` predicates are specified
8-
--> $DIR/doc-cfg.rs:3:23
9+
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value items
10+
--> $DIR/doc-cfg.rs:12:21
911
|
10-
LL | #[doc(cfg(), cfg(foo, bar))]
11-
| ^^^
12+
LL | #[doc(auto_cfg(hide(true)))]
13+
| ^^^^
1214

13-
error: `cfg` predicate is not specified
14-
--> $DIR/doc-cfg.rs:9:7
15+
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value items
16+
--> $DIR/doc-cfg.rs:13:21
1517
|
16-
LL | #[doc(cfg())]
17-
| ^^^^^ help: expected syntax is: `cfg(/* predicate */)`
18+
LL | #[doc(auto_cfg(hide(42)))]
19+
| ^^
1820

19-
error: multiple `cfg` predicates are specified
20-
--> $DIR/doc-cfg.rs:10:16
21+
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value items
22+
--> $DIR/doc-cfg.rs:14:21
2123
|
22-
LL | #[doc(cfg(foo, bar))]
23-
| ^^^
24+
LL | #[doc(auto_cfg(hide("a")))]
25+
| ^^^
26+
27+
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value items
28+
--> $DIR/doc-cfg.rs:15:21
29+
|
30+
LL | #[doc(auto_cfg(hide(foo::bar)))]
31+
| ^^^^^^^^
2432

2533
warning: unexpected `cfg` condition name: `foo`
2634
--> $DIR/doc-cfg.rs:6:11
@@ -42,5 +50,29 @@ LL | #[doc(cfg(foo), cfg(bar))]
4250
= help: to expect this configuration use `--check-cfg=cfg(bar)`
4351
= note: see <https://doc.rust-lang.org/nightly/rustc/check-cfg.html> for more information about checking conditional configuration
4452

45-
error: aborting due to 4 previous errors; 2 warnings emitted
53+
error: `cfg` predicate is not specified
54+
--> $DIR/doc-cfg.rs:3:7
55+
|
56+
LL | #[doc(cfg(), cfg(foo, bar))]
57+
| ^^^^^ help: expected syntax is: `cfg(/* predicate */)`
58+
59+
error: multiple `cfg` predicates are specified
60+
--> $DIR/doc-cfg.rs:3:23
61+
|
62+
LL | #[doc(cfg(), cfg(foo, bar))]
63+
| ^^^
64+
65+
error: `cfg` predicate is not specified
66+
--> $DIR/doc-cfg.rs:9:7
67+
|
68+
LL | #[doc(cfg())]
69+
| ^^^^^ help: expected syntax is: `cfg(/* predicate */)`
70+
71+
error: multiple `cfg` predicates are specified
72+
--> $DIR/doc-cfg.rs:10:16
73+
|
74+
LL | #[doc(cfg(foo, bar))]
75+
| ^^^
76+
77+
error: aborting due to 9 previous errors; 2 warnings emitted
4678

‎tests/rustdoc-ui/feature-gate-doc_cfg.rs‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#![doc(auto_cfg)] //~ ERROR
2+
#![doc(auto_cfg(false))] //~ ERROR
3+
#![doc(auto_cfg(true))] //~ ERROR
4+
#![doc(auto_cfg(hide(feature = "solecism")))] //~ ERROR
5+
#![doc(auto_cfg(show(feature = "bla")))] //~ ERROR
6+
#![doc(cfg(feature = "solecism"))] //~ ERROR

‎tests/rustdoc-ui/feature-gate-doc_cfg.stderr‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
error[E0658]: `#[doc(auto_cfg)]` is experimental
2+
--> $DIR/feature-gate-doc_cfg.rs:1:1
3+
|
4+
LL | #![doc(auto_cfg)]
5+
| ^^^^^^^^^^^^^^^^^
6+
|
7+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
8+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
9+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
10+
11+
error[E0658]: `#[doc(auto_cfg)]` is experimental
12+
--> $DIR/feature-gate-doc_cfg.rs:2:1
13+
|
14+
LL | #![doc(auto_cfg(false))]
15+
| ^^^^^^^^^^^^^^^^^^^^^^^^
16+
|
17+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
18+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
19+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
20+
21+
error[E0658]: `#[doc(auto_cfg)]` is experimental
22+
--> $DIR/feature-gate-doc_cfg.rs:3:1
23+
|
24+
LL | #![doc(auto_cfg(true))]
25+
| ^^^^^^^^^^^^^^^^^^^^^^^
26+
|
27+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
28+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
29+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
30+
31+
error[E0658]: `#[doc(auto_cfg)]` is experimental
32+
--> $DIR/feature-gate-doc_cfg.rs:4:1
33+
|
34+
LL | #![doc(auto_cfg(hide(feature = "solecism")))]
35+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
36+
|
37+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
38+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
39+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
40+
41+
error[E0658]: `#[doc(auto_cfg)]` is experimental
42+
--> $DIR/feature-gate-doc_cfg.rs:5:1
43+
|
44+
LL | #![doc(auto_cfg(show(feature = "bla")))]
45+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
46+
|
47+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
48+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
49+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
50+
51+
error[E0658]: `#[doc(cfg)]` is experimental
52+
--> $DIR/feature-gate-doc_cfg.rs:6:1
53+
|
54+
LL | #![doc(cfg(feature = "solecism"))]
55+
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
|
57+
= note: see issue #43781 <https://github.com/rust-lang/rust/issues/43781> for more information
58+
= help: add `#![feature(doc_cfg)]` to the crate attributes to enable
59+
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
60+
61+
error: aborting due to 6 previous errors
62+
63+
For more information about this error, try `rustc --explain E0658`.

0 commit comments

Comments
 (0)