Skip to content

Commit 41ea824

Browse files
GuillaumeGomezGuillaumeGomez
committed
Improve code and better check doc(cfg(...)) attributes
1 parent 4f60324 commit 41ea824

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
@@ -171,7 +171,7 @@ passes_doc_auto_cfg_hide_show_expects_list =
171171
`#![doc(auto_cfg({$attr_name}(...)))]` expects a list of items
172172
173173
passes_doc_auto_cfg_hide_show_unexpected_item =
174-
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/values items
174+
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/value items
175175
176176
passes_doc_auto_cfg_wrong_literal =
177177
`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
@@ -1287,7 +1287,15 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
12871287
}
12881288
MetaItemKind::List(list) => {
12891289
for item in list {
1290-
let Some(attr_name) = item.name() else { continue };
1290+
let Some(attr_name) = item.name() else {
1291+
self.tcx.emit_node_span_lint(
1292+
INVALID_DOC_ATTRIBUTES,
1293+
hir_id,
1294+
meta.span,
1295+
errors::DocAutoCfgExpectsHideOrShow,
1296+
);
1297+
continue;
1298+
};
12911299
if attr_name != sym::hide && attr_name != sym::show {
12921300
self.tcx.emit_node_span_lint(
12931301
INVALID_DOC_ATTRIBUTES,
@@ -1306,6 +1314,19 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
13061314
attr_name: attr_name.as_str(),
13071315
},
13081316
);
1317+
} else if match item {
1318+
MetaItemInner::Lit(_) => true,
1319+
// We already checked above that it's not a list.
1320+
MetaItemInner::MetaItem(meta) => meta.path.segments.len() != 1,
1321+
} {
1322+
self.tcx.emit_node_span_lint(
1323+
INVALID_DOC_ATTRIBUTES,
1324+
hir_id,
1325+
item.span(),
1326+
errors::DocAutoCfgHideShowUnexpectedItem {
1327+
attr_name: attr_name.as_str(),
1328+
},
1329+
);
13091330
}
13101331
}
13111332
} else {

‎compiler/rustc_span/src/symbol.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,6 @@ symbols! {
11271127
hashset_iter_ty,
11281128
hexagon_target_feature,
11291129
hidden,
1130-
hidden_cfg,
11311130
hide,
11321131
hint,
11331132
homogeneous_aggregate,

‎src/librustdoc/clean/inline.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -596,6 +596,10 @@ pub(crate) fn build_impl(
596596
});
597597
}
598598

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

‎src/librustdoc/clean/types.rs

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,8 +1042,10 @@ fn show_hide_show_conflict_error(
10421042
diag.emit();
10431043
}
10441044

1045-
/// This function checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1046-
/// `auto_cfg(show(...))` on the same item. If so, it emits an error.
1045+
/// This functions updates the `hidden_cfg` field of the provided `cfg_info` argument.
1046+
///
1047+
/// It also checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1048+
/// `auto_cfg(show(...))` on the same item and emits an error if it's the case.
10471049
///
10481050
/// Because we go through a list of `cfg`s, we keep track of the `cfg`s we saw in `new_show_attrs`
10491051
/// and in `new_hide_attrs` arguments.
@@ -1095,6 +1097,31 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
10951097
Some(item)
10961098
}
10971099

1100+
fn check_changed_auto_active_status(
1101+
changed_auto_active_status: &mut Option<rustc_span::Span>,
1102+
attr: &ast::MetaItem,
1103+
cfg_info: &mut CfgInfo,
1104+
tcx: TyCtxt<'_>,
1105+
new_value: bool,
1106+
) -> bool {
1107+
if let Some(first_change) = changed_auto_active_status {
1108+
if cfg_info.auto_cfg_active != new_value {
1109+
tcx.sess
1110+
.dcx()
1111+
.struct_span_err(
1112+
vec![*first_change, attr.span],
1113+
"`auto_cfg` was disabled and enabled more than once on the same item",
1114+
)
1115+
.emit();
1116+
return true;
1117+
}
1118+
} else {
1119+
*changed_auto_active_status = Some(attr.span);
1120+
}
1121+
cfg_info.auto_cfg_active = new_value;
1122+
false
1123+
}
1124+
10981125
let mut new_show_attrs = FxHashMap::default();
10991126
let mut new_hide_attrs = FxHashMap::default();
11001127

@@ -1142,49 +1169,39 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
11421169
};
11431170
match &attr.kind {
11441171
MetaItemKind::Word => {
1145-
if let Some(first_change) = changed_auto_active_status {
1146-
if !cfg_info.auto_cfg_active {
1147-
tcx.sess.dcx().struct_span_err(
1148-
vec![first_change, attr.span],
1149-
"`auto_cfg` was disabled and enabled more than once on the same item",
1150-
).emit();
1151-
return None;
1152-
}
1153-
} else {
1154-
changed_auto_active_status = Some(attr.span);
1172+
if check_changed_auto_active_status(
1173+
&mut changed_auto_active_status,
1174+
attr,
1175+
cfg_info,
1176+
tcx,
1177+
true,
1178+
) {
1179+
return None;
11551180
}
1156-
cfg_info.auto_cfg_active = true;
11571181
}
11581182
MetaItemKind::NameValue(lit) => {
11591183
if let LitKind::Bool(value) = lit.kind {
1160-
if let Some(first_change) = changed_auto_active_status {
1161-
if cfg_info.auto_cfg_active != value {
1162-
tcx.sess.dcx().struct_span_err(
1163-
vec![first_change, attr.span],
1164-
"`auto_cfg` was disabled and enabled more than once on the same item",
1165-
).emit();
1166-
return None;
1167-
}
1168-
} else {
1169-
changed_auto_active_status = Some(attr.span);
1184+
if check_changed_auto_active_status(
1185+
&mut changed_auto_active_status,
1186+
attr,
1187+
cfg_info,
1188+
tcx,
1189+
value,
1190+
) {
1191+
return None;
11701192
}
1171-
cfg_info.auto_cfg_active = value;
11721193
}
11731194
}
11741195
MetaItemKind::List(sub_attrs) => {
1175-
if let Some(first_change) = changed_auto_active_status {
1176-
if !cfg_info.auto_cfg_active {
1177-
tcx.sess.dcx().struct_span_err(
1178-
vec![first_change, attr.span],
1179-
"`auto_cfg` was disabled and enabled more than once on the same item",
1180-
).emit();
1181-
return None;
1182-
}
1183-
} else {
1184-
changed_auto_active_status = Some(attr.span);
1196+
if check_changed_auto_active_status(
1197+
&mut changed_auto_active_status,
1198+
attr,
1199+
cfg_info,
1200+
tcx,
1201+
true,
1202+
) {
1203+
return None;
11851204
}
1186-
// Whatever happens next, the feature is enabled again.
1187-
cfg_info.auto_cfg_active = true;
11881205
for sub_attr in sub_attrs.iter() {
11891206
if let Some(ident) = sub_attr.ident()
11901207
&& (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`.

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

Lines changed: 0 additions & 8 deletions
This file was deleted.

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

Lines changed: 0 additions & 10 deletions
This file was deleted.

‎tests/rustdoc-ui/lints/doc_cfg_hide.stderr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ error: `#![doc(auto_cfg(hide(...)))]` expects a list of items
1212
LL | #![doc(auto_cfg(hide))]
1313
| ^^^^^^^^^^^^^^
1414

15-
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/values items
15+
error: `#![doc(auto_cfg(hide(...)))]` only accepts identifiers or key/value items
1616
--> $DIR/doc_cfg_hide.rs:4:22
1717
|
1818
LL | #![doc(auto_cfg(hide(not(windows))))]

0 commit comments

Comments
 (0)