-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Warn on #![doc(test(...))]
on items other than the crate root and use future incompatible lint
#82708
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Warn on #![doc(test(...))]
on items other than the crate root and use future incompatible lint
#82708
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6f32e3e
Add new edition 2021 link: INVALID_DOC_ATTRIBUTE
GuillaumeGomez a66bf52
Add extra check for #[doc(test(...)] attribute
GuillaumeGomez 85c3d10
Add tests for #[doc(test(...)] check
GuillaumeGomez 55cec90
Also use INVALID_DOC_ATTRIBUTE for "unknown doc attribute" warnings
GuillaumeGomez a11e87e
Make invalid_doc_attribute lint plural
GuillaumeGomez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
#![crate_type = "lib"] | ||
#![deny(unused_attributes)] | ||
//~^ NOTE lint level is defined here | ||
#![deny(warnings)] | ||
#![doc(as_ptr)] | ||
//~^ ERROR unknown `doc` attribute | ||
//~| WARNING will become a hard error in a future release | ||
//~^^ WARN | ||
|
||
#[doc(as_ptr)] | ||
//~^ ERROR unknown `doc` attribute | ||
//~| WARNING will become a hard error in a future release | ||
//~^^ WARN | ||
pub fn foo() {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,26 @@ | ||
error: unknown `doc` attribute `as_ptr` | ||
--> $DIR/doc-attr.rs:8:7 | ||
--> $DIR/doc-attr.rs:7:7 | ||
| | ||
LL | #[doc(as_ptr)] | ||
| ^^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/doc-attr.rs:2:9 | ||
| | ||
LL | #![deny(unused_attributes)] | ||
| ^^^^^^^^^^^^^^^^^ | ||
LL | #![deny(warnings)] | ||
| ^^^^^^^^ | ||
= note: `#[deny(invalid_doc_attribute)]` 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> | ||
|
||
error: unknown `doc` attribute `as_ptr` | ||
--> $DIR/doc-attr.rs:4:8 | ||
--> $DIR/doc-attr.rs:3:8 | ||
| | ||
LL | #![doc(as_ptr)] | ||
| ^^^^^^ | ||
| | ||
= 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 2 previous errors | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
#![crate_type = "lib"] | ||
#![deny(warnings)] | ||
|
||
#[doc(test(no_crate_inject))] //~ ERROR | ||
//~^ WARN | ||
pub fn foo() {} | ||
|
||
pub mod bar { | ||
#![doc(test(no_crate_inject))] //~ ERROR | ||
//~^ WARN | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
error: `#![doc(test(...)]` is only allowed as a crate level attribute | ||
--> $DIR/doc-attr2.rs:4:7 | ||
| | ||
LL | #[doc(test(no_crate_inject))] | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/doc-attr2.rs:2:9 | ||
| | ||
LL | #![deny(warnings)] | ||
| ^^^^^^^^ | ||
= note: `#[deny(invalid_doc_attribute)]` 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> | ||
|
||
error: `#![doc(test(...)]` is only allowed as a crate level attribute | ||
--> $DIR/doc-attr2.rs:9:12 | ||
| | ||
LL | #![doc(test(no_crate_inject))] | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| | ||
= 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 2 previous errors | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,10 @@ | ||
#![crate_type = "lib"] | ||
#![deny(unused_attributes)] | ||
//~^ NOTE lint level is defined here | ||
#![deny(warnings)] | ||
#![doc(as_ptr)] | ||
//~^ ERROR unknown `doc` attribute | ||
//~| WARNING will become a hard error in a future release | ||
//~^^ WARN | ||
|
||
#[doc(as_ptr)] | ||
//~^ ERROR unknown `doc` attribute | ||
//~| WARNING will become a hard error in a future release | ||
//~^^ WARN | ||
pub fn foo() {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,26 @@ | ||
error: unknown `doc` attribute `as_ptr` | ||
--> $DIR/doc-attr.rs:8:7 | ||
--> $DIR/doc-attr.rs:7:7 | ||
| | ||
LL | #[doc(as_ptr)] | ||
| ^^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/doc-attr.rs:2:9 | ||
| | ||
LL | #![deny(unused_attributes)] | ||
| ^^^^^^^^^^^^^^^^^ | ||
LL | #![deny(warnings)] | ||
| ^^^^^^^^ | ||
= note: `#[deny(invalid_doc_attribute)]` 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> | ||
|
||
error: unknown `doc` attribute `as_ptr` | ||
--> $DIR/doc-attr.rs:4:8 | ||
--> $DIR/doc-attr.rs:3:8 | ||
| | ||
LL | #![doc(as_ptr)] | ||
| ^^^^^^ | ||
| | ||
= 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 2 previous errors | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
#![crate_type = "lib"] | ||
#![deny(warnings)] | ||
|
||
#[doc(test(no_crate_inject))] //~ ERROR | ||
//~^ WARN | ||
pub fn foo() {} | ||
|
||
pub mod bar { | ||
#![doc(test(no_crate_inject))] //~ ERROR | ||
//~^ WARN | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
error: `#![doc(test(...)]` is only allowed as a crate level attribute | ||
--> $DIR/doc-attr2.rs:4:7 | ||
| | ||
LL | #[doc(test(no_crate_inject))] | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| | ||
note: the lint level is defined here | ||
--> $DIR/doc-attr2.rs:2:9 | ||
| | ||
LL | #![deny(warnings)] | ||
| ^^^^^^^^ | ||
= note: `#[deny(invalid_doc_attribute)]` 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> | ||
|
||
error: `#![doc(test(...)]` is only allowed as a crate level attribute | ||
--> $DIR/doc-attr2.rs:9:12 | ||
| | ||
LL | #![doc(test(no_crate_inject))] | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
| | ||
= 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 2 previous errors | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lint names should be plural: https://github.com/rust-lang/rfcs/blob/master/text/0344-conventions-galore.md#lints