Skip to content

Commit 0711ac3

Browse files
GuillaumeGomezGuillaumeGomez
committed
Improve code and better check doc(cfg(...)) attributes
1 parent 499662e commit 0711ac3

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
@@ -179,7 +179,7 @@ passes_doc_auto_cfg_hide_show_expects_list =
179179
`#![doc(auto_cfg({$attr_name}(...)))]` expects a list of items
180180
181181
passes_doc_auto_cfg_hide_show_unexpected_item =
182-
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/values items
182+
`#![doc(auto_cfg({$attr_name}(...)))]` only accepts identifiers or key/value items
183183
184184
passes_doc_auto_cfg_wrong_literal =
185185
`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
@@ -1380,7 +1380,15 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
13801380
}
13811381
MetaItemKind::List(list) => {
13821382
for item in list {
1383-
let Some(attr_name) = item.name() else { continue };
1383+
let Some(attr_name) = item.name() else {
1384+
self.tcx.emit_node_span_lint(
1385+
INVALID_DOC_ATTRIBUTES,
1386+
hir_id,
1387+
meta.span,
1388+
errors::DocAutoCfgExpectsHideOrShow,
1389+
);
1390+
continue;
1391+
};
13841392
if attr_name != sym::hide && attr_name != sym::show {
13851393
self.tcx.emit_node_span_lint(
13861394
INVALID_DOC_ATTRIBUTES,
@@ -1399,6 +1407,19 @@ impl<'tcx> CheckAttrVisitor<'tcx> {
13991407
attr_name: attr_name.as_str(),
14001408
},
14011409
);
1410+
} else if match item {
1411+
MetaItemInner::Lit(_) => true,
1412+
// We already checked above that it's not a list.
1413+
MetaItemInner::MetaItem(meta) => meta.path.segments.len() != 1,
1414+
} {
1415+
self.tcx.emit_node_span_lint(
1416+
INVALID_DOC_ATTRIBUTES,
1417+
hir_id,
1418+
item.span(),
1419+
errors::DocAutoCfgHideShowUnexpectedItem {
1420+
attr_name: attr_name.as_str(),
1421+
},
1422+
);
14021423
}
14031424
}
14041425
} else {

‎compiler/rustc_span/src/symbol.rs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1130,7 +1130,6 @@ symbols! {
11301130
hashset_iter_ty,
11311131
hexagon_target_feature,
11321132
hidden,
1133-
hidden_cfg,
11341133
hide,
11351134
hint,
11361135
homogeneous_aggregate,

‎src/librustdoc/clean/inline.rs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,6 +602,10 @@ pub(crate) fn build_impl(
602602
});
603603
}
604604

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

‎src/librustdoc/clean/types.rs‎

Lines changed: 53 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,8 +1036,10 @@ fn show_hide_show_conflict_error(
10361036
diag.emit();
10371037
}
10381038

1039-
/// This function checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1040-
/// `auto_cfg(show(...))` on the same item. If so, it emits an error.
1039+
/// This functions updates the `hidden_cfg` field of the provided `cfg_info` argument.
1040+
///
1041+
/// It also checks if a same `cfg` is present in both `auto_cfg(hide(...))` and
1042+
/// `auto_cfg(show(...))` on the same item and emits an error if it's the case.
10411043
///
10421044
/// Because we go through a list of `cfg`s, we keep track of the `cfg`s we saw in `new_show_attrs`
10431045
/// and in `new_hide_attrs` arguments.
@@ -1089,6 +1091,31 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
10891091
Some(item)
10901092
}
10911093

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

@@ -1136,49 +1163,39 @@ pub(crate) fn extract_cfg_from_attrs<'a, I: Iterator<Item = &'a hir::Attribute>
11361163
};
11371164
match &attr.kind {
11381165
MetaItemKind::Word => {
1139-
if let Some(first_change) = changed_auto_active_status {
1140-
if !cfg_info.auto_cfg_active {
1141-
tcx.sess.dcx().struct_span_err(
1142-
vec![first_change, attr.span],
1143-
"`auto_cfg` was disabled and enabled more than once on the same item",
1144-
).emit();
1145-
return None;
1146-
}
1147-
} else {
1148-
changed_auto_active_status = Some(attr.span);
1166+
if check_changed_auto_active_status(
1167+
&mut changed_auto_active_status,
1168+
attr,
1169+
cfg_info,
1170+
tcx,
1171+
true,
1172+
) {
1173+
return None;
11491174
}
1150-
cfg_info.auto_cfg_active = true;
11511175
}
11521176
MetaItemKind::NameValue(lit) => {
11531177
if let LitKind::Bool(value) = lit.kind {
1154-
if let Some(first_change) = changed_auto_active_status {
1155-
if cfg_info.auto_cfg_active != value {
1156-
tcx.sess.dcx().struct_span_err(
1157-
vec![first_change, attr.span],
1158-
"`auto_cfg` was disabled and enabled more than once on the same item",
1159-
).emit();
1160-
return None;
1161-
}
1162-
} else {
1163-
changed_auto_active_status = Some(attr.span);
1178+
if check_changed_auto_active_status(
1179+
&mut changed_auto_active_status,
1180+
attr,
1181+
cfg_info,
1182+
tcx,
1183+
value,
1184+
) {
1185+
return None;
11641186
}
1165-
cfg_info.auto_cfg_active = value;
11661187
}
11671188
}
11681189
MetaItemKind::List(sub_attrs) => {
1169-
if let Some(first_change) = changed_auto_active_status {
1170-
if !cfg_info.auto_cfg_active {
1171-
tcx.sess.dcx().struct_span_err(
1172-
vec![first_change, attr.span],
1173-
"`auto_cfg` was disabled and enabled more than once on the same item",
1174-
).emit();
1175-
return None;
1176-
}
1177-
} else {
1178-
changed_auto_active_status = Some(attr.span);
1190+
if check_changed_auto_active_status(
1191+
&mut changed_auto_active_status,
1192+
attr,
1193+
cfg_info,
1194+
tcx,
1195+
true,
1196+
) {
1197+
return None;
11791198
}
1180-
// Whatever happens next, the feature is enabled again.
1181-
cfg_info.auto_cfg_active = true;
11821199
for sub_attr in sub_attrs.iter() {
11831200
if let Some(ident) = sub_attr.ident()
11841201
&& (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)