Skip to content

Commit

Permalink
Rollup merge of #85501 - jyn514:invalid-doc-attrs, r=varkor
Browse files Browse the repository at this point in the history
Fix `deny(invalid_doc_attributes)`

Fixes #85497.
  • Loading branch information
GuillaumeGomez authored Jun 5, 2021
2 parents 1594076 + 261f643 commit 515c5af
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 11 deletions.
1 change: 1 addition & 0 deletions compiler/rustc_lint_defs/src/builtin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2994,6 +2994,7 @@ declare_lint_pass! {
USELESS_DEPRECATED,
UNSUPPORTED_NAKED_FUNCTIONS,
MISSING_ABI,
INVALID_DOC_ATTRIBUTES,
SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
DISJOINT_CAPTURE_MIGRATION,
LEGACY_DERIVE_HELPERS,
Expand Down
3 changes: 2 additions & 1 deletion src/librustdoc/core.rs
Original file line number Diff line number Diff line change
Expand Up @@ -217,8 +217,9 @@ crate fn create_config(
// By default, rustdoc ignores all lints.
// Specifically unblock lints relevant to documentation or the lint machinery itself.
let mut lints_to_show = vec![
// it's unclear whether this should be part of rustdoc directly (#77364)
// it's unclear whether these should be part of rustdoc directly (#77364)
rustc_lint::builtin::MISSING_DOCS.name.to_string(),
rustc_lint::builtin::INVALID_DOC_ATTRIBUTES.name.to_string(),
// these are definitely not part of rustdoc, but we want to warn on them anyway.
rustc_lint::builtin::RENAMED_AND_REMOVED_LINTS.name.to_string(),
rustc_lint::builtin::UNKNOWN_LINTS.name.to_string(),
Expand Down
5 changes: 2 additions & 3 deletions src/test/rustdoc-ui/doc-spotlight.fixed
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
// check-pass
// run-rustfix

#![deny(warnings)]
#![feature(doc_notable_trait)]

#[doc(notable_trait)]
//~^ WARN unknown `doc` attribute `spotlight`
//~^ ERROR unknown `doc` attribute `spotlight`
//~| WARN this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
trait MyTrait {}
5 changes: 2 additions & 3 deletions src/test/rustdoc-ui/doc-spotlight.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
// check-pass
// run-rustfix

#![deny(warnings)]
#![feature(doc_notable_trait)]

#[doc(spotlight)]
//~^ WARN unknown `doc` attribute `spotlight`
//~^ ERROR unknown `doc` attribute `spotlight`
//~| WARN this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
trait MyTrait {}
13 changes: 9 additions & 4 deletions src/test/rustdoc-ui/doc-spotlight.stderr
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
warning: unknown `doc` attribute `spotlight`
--> $DIR/doc-spotlight.rs:6:7
error: unknown `doc` attribute `spotlight`
--> $DIR/doc-spotlight.rs:5:7
|
LL | #[doc(spotlight)]
| ^^^^^^^^^ help: use `notable_trait` instead
|
= note: `#[warn(invalid_doc_attributes)]` on by default
note: the lint level is defined here
--> $DIR/doc-spotlight.rs:2:9
|
LL | #![deny(warnings)]
| ^^^^^^^^
= note: `#[deny(invalid_doc_attributes)]` implied by `#[deny(warnings)]`
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>
= note: `doc(spotlight)` was renamed to `doc(notable_trait)`
= note: `doc(spotlight)` is now a no-op

warning: 1 warning emitted
error: aborting due to previous error

7 changes: 7 additions & 0 deletions src/test/ui/rustdoc/deny-invalid-doc-attrs.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#![deny(invalid_doc_attributes)]
//~^ NOTE defined here
#![doc(x)]
//~^ ERROR unknown `doc` attribute `x`
//~| WARNING will become a hard error
//~| NOTE see issue #82730
fn main() {}
16 changes: 16 additions & 0 deletions src/test/ui/rustdoc/deny-invalid-doc-attrs.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
error: unknown `doc` attribute `x`
--> $DIR/deny-invalid-doc-attrs.rs:3:8
|
LL | #![doc(x)]
| ^
|
note: the lint level is defined here
--> $DIR/deny-invalid-doc-attrs.rs:1:9
|
LL | #![deny(invalid_doc_attributes)]
| ^^^^^^^^^^^^^^^^^^^^^^
= warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
= note: for more information, see issue #82730 <https://github.com/rust-lang/rust/issues/82730>

error: aborting due to previous error

0 comments on commit 515c5af

Please sign in to comment.