Skip to content

Commit 8867f7f

Browse files
GuillaumeGomezGuillaumeGomez
authored
Rollup merge of #82708 - GuillaumeGomez:doc-test-attr-check, r=Manishearth
Warn on `#![doc(test(...))]` on items other than the crate root and use future incompatible lint Part of #82672. This PR does multiple things: * Create a new `INVALID_DOC_ATTRIBUTE` lint which is also "future incompatible", allowing us to use it as a warning for the moment until it turns (eventually) into a hard error. * Use this link when `#![doc(test(...))]` isn't used at the crate level. * Make #82702 use this new lint as well. r? ``@jyn514``
2 parents 92861c7 + a11e87e commit 8867f7f

File tree

10 files changed

+143
-23
lines changed

10 files changed

+143
-23
lines changed

‎compiler/rustc_lint_defs/src/builtin.rs

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3059,3 +3059,33 @@ declare_lint! {
30593059
Allow,
30603060
"No declared ABI for extern declaration"
30613061
}
3062+
3063+
declare_lint! {
3064+
/// The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is
3065+
/// misused.
3066+
///
3067+
/// ### Example
3068+
///
3069+
/// ```rust,compile_fail
3070+
/// #![deny(warnings)]
3071+
///
3072+
/// pub mod submodule {
3073+
/// #![doc(test(no_crate_inject))]
3074+
/// }
3075+
/// ```
3076+
///
3077+
/// {{produces}}
3078+
///
3079+
/// ### Explanation
3080+
///
3081+
/// Previously, there were very like checks being performed on `#[doc(..)]`
3082+
/// unlike the other attributes. It'll now catch all the issues that it
3083+
/// silently ignored previously.
3084+
pub INVALID_DOC_ATTRIBUTES,
3085+
Warn,
3086+
"detects invalid `#[doc(...)]` attributes",
3087+
@future_incompatible = FutureIncompatibleInfo {
3088+
reference: "issue #82730 <https://github.com/rust-lang/rust/issues/82730>",
3089+
edition: None,
3090+
};
3091+
}

‎compiler/rustc_passes/src/check_attr.rs

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@ use rustc_hir::{
1717
self, FnSig, ForeignItem, ForeignItemKind, HirId, Item, ItemKind, TraitItem, CRATE_HIR_ID,
1818
};
1919
use rustc_hir::{MethodKind, Target};
20-
use rustc_session::lint::builtin::{CONFLICTING_REPR_HINTS, UNUSED_ATTRIBUTES};
20+
use rustc_session::lint::builtin::{
21+
CONFLICTING_REPR_HINTS, INVALID_DOC_ATTRIBUTES, UNUSED_ATTRIBUTES,
22+
};
2123
use rustc_session::parse::feature_err;
2224
use rustc_span::symbol::{sym, Symbol};
2325
use rustc_span::{Span, DUMMY_SP};
@@ -544,6 +546,21 @@ impl CheckAttrVisitor<'tcx> {
544546
{
545547
return false;
546548
}
549+
} else if meta.has_name(sym::test) {
550+
if CRATE_HIR_ID != hir_id {
551+
self.tcx.struct_span_lint_hir(
552+
INVALID_DOC_ATTRIBUTES,
553+
hir_id,
554+
meta.span(),
555+
|lint| {
556+
lint.build(
557+
"`#![doc(test(...)]` is only allowed as a crate level attribute"
558+
)
559+
.emit();
560+
},
561+
);
562+
return false;
563+
}
547564
} else if let Some(i_meta) = meta.meta_item() {
548565
if ![
549566
sym::cfg,
@@ -568,19 +585,14 @@ impl CheckAttrVisitor<'tcx> {
568585
.any(|m| i_meta.has_name(*m))
569586
{
570587
self.tcx.struct_span_lint_hir(
571-
UNUSED_ATTRIBUTES,
588+
INVALID_DOC_ATTRIBUTES,
572589
hir_id,
573590
i_meta.span,
574591
|lint| {
575592
lint.build(&format!(
576593
"unknown `doc` attribute `{}`",
577594
i_meta.name_or_empty()
578595
))
579-
.warn(
580-
"this was previously accepted by the compiler but is \
581-
being phased out; it will become a hard error in \
582-
a future release!",
583-
)
584596
.emit();
585597
},
586598
);

‎src/test/rustdoc-ui/doc-attr.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
#![crate_type = "lib"]
2-
#![deny(unused_attributes)]
3-
//~^ NOTE lint level is defined here
2+
#![deny(warnings)]
43
#![doc(as_ptr)]
54
//~^ ERROR unknown `doc` attribute
6-
//~| WARNING will become a hard error in a future release
5+
//~^^ WARN
76

87
#[doc(as_ptr)]
98
//~^ ERROR unknown `doc` attribute
10-
//~| WARNING will become a hard error in a future release
9+
//~^^ WARN
1110
pub fn foo() {}

‎src/test/rustdoc-ui/doc-attr.stderr

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
error: unknown `doc` attribute `as_ptr`
2-
--> $DIR/doc-attr.rs:8:7
2+
--> $DIR/doc-attr.rs:7:7
33
|
44
LL | #[doc(as_ptr)]
55
| ^^^^^^
66
|
77
note: the lint level is defined here
88
--> $DIR/doc-attr.rs:2:9
99
|
10-
LL | #![deny(unused_attributes)]
11-
| ^^^^^^^^^^^^^^^^^
10+
LL | #![deny(warnings)]
11+
| ^^^^^^^^
12+
= note: `#[deny(invalid_doc_attributes)]` implied by `#[deny(warnings)]`
1213
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
14+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
1315

1416
error: unknown `doc` attribute `as_ptr`
15-
--> $DIR/doc-attr.rs:4:8
17+
--> $DIR/doc-attr.rs:3:8
1618
|
1719
LL | #![doc(as_ptr)]
1820
| ^^^^^^
1921
|
2022
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
23+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
2124

2225
error: aborting due to 2 previous errors
2326

‎src/test/rustdoc-ui/doc-attr2.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#![crate_type = "lib"]
2+
#![deny(warnings)]
3+
4+
#[doc(test(no_crate_inject))] //~ ERROR
5+
//~^ WARN
6+
pub fn foo() {}
7+
8+
pub mod bar {
9+
#![doc(test(no_crate_inject))] //~ ERROR
10+
//~^ WARN
11+
}

‎src/test/rustdoc-ui/doc-attr2.stderr

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
error: `#![doc(test(...)]` is only allowed as a crate level attribute
2+
--> $DIR/doc-attr2.rs:4:7
3+
|
4+
LL | #[doc(test(no_crate_inject))]
5+
| ^^^^^^^^^^^^^^^^^^^^^
6+
|
7+
note: the lint level is defined here
8+
--> $DIR/doc-attr2.rs:2:9
9+
|
10+
LL | #![deny(warnings)]
11+
| ^^^^^^^^
12+
= note: `#[deny(invalid_doc_attributes)]` implied by `#[deny(warnings)]`
13+
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
14+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
15+
16+
error: `#![doc(test(...)]` is only allowed as a crate level attribute
17+
--> $DIR/doc-attr2.rs:9:12
18+
|
19+
LL | #![doc(test(no_crate_inject))]
20+
| ^^^^^^^^^^^^^^^^^^^^^
21+
|
22+
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
23+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
24+
25+
error: aborting due to 2 previous errors
26+

‎src/test/ui/attributes/doc-attr.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
#![crate_type = "lib"]
2-
#![deny(unused_attributes)]
3-
//~^ NOTE lint level is defined here
2+
#![deny(warnings)]
43
#![doc(as_ptr)]
54
//~^ ERROR unknown `doc` attribute
6-
//~| WARNING will become a hard error in a future release
5+
//~^^ WARN
76

87
#[doc(as_ptr)]
98
//~^ ERROR unknown `doc` attribute
10-
//~| WARNING will become a hard error in a future release
9+
//~^^ WARN
1110
pub fn foo() {}

‎src/test/ui/attributes/doc-attr.stderr

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
error: unknown `doc` attribute `as_ptr`
2-
--> $DIR/doc-attr.rs:8:7
2+
--> $DIR/doc-attr.rs:7:7
33
|
44
LL | #[doc(as_ptr)]
55
| ^^^^^^
66
|
77
note: the lint level is defined here
88
--> $DIR/doc-attr.rs:2:9
99
|
10-
LL | #![deny(unused_attributes)]
11-
| ^^^^^^^^^^^^^^^^^
10+
LL | #![deny(warnings)]
11+
| ^^^^^^^^
12+
= note: `#[deny(invalid_doc_attributes)]` implied by `#[deny(warnings)]`
1213
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
14+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
1315

1416
error: unknown `doc` attribute `as_ptr`
15-
--> $DIR/doc-attr.rs:4:8
17+
--> $DIR/doc-attr.rs:3:8
1618
|
1719
LL | #![doc(as_ptr)]
1820
| ^^^^^^
1921
|
2022
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
23+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
2124

2225
error: aborting due to 2 previous errors
2326

‎src/test/ui/attributes/doc-attr2.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#![crate_type = "lib"]
2+
#![deny(warnings)]
3+
4+
#[doc(test(no_crate_inject))] //~ ERROR
5+
//~^ WARN
6+
pub fn foo() {}
7+
8+
pub mod bar {
9+
#![doc(test(no_crate_inject))] //~ ERROR
10+
//~^ WARN
11+
}

‎src/test/ui/attributes/doc-attr2.stderr

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
error: `#![doc(test(...)]` is only allowed as a crate level attribute
2+
--> $DIR/doc-attr2.rs:4:7
3+
|
4+
LL | #[doc(test(no_crate_inject))]
5+
| ^^^^^^^^^^^^^^^^^^^^^
6+
|
7+
note: the lint level is defined here
8+
--> $DIR/doc-attr2.rs:2:9
9+
|
10+
LL | #![deny(warnings)]
11+
| ^^^^^^^^
12+
= note: `#[deny(invalid_doc_attributes)]` implied by `#[deny(warnings)]`
13+
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
14+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
15+
16+
error: `#![doc(test(...)]` is only allowed as a crate level attribute
17+
--> $DIR/doc-attr2.rs:9:12
18+
|
19+
LL | #![doc(test(no_crate_inject))]
20+
| ^^^^^^^^^^^^^^^^^^^^^
21+
|
22+
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
23+
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
24+
25+
error: aborting due to 2 previous errors
26+

0 commit comments

Comments
 (0)