1
Fork 0

Rollup merge of #82798 - jyn514:rustdoc-group, r=Manishearth,GuillaumeGomez

Rename `rustdoc` to `rustdoc::all`

When rustdoc lints were changed to be tool lints, the `rustdoc` group was removed, leading to spurious warnings like

```
warning: unknown lint: `rustdoc`
```

The lint group still worked when rustdoc ran, since rustdoc added the group itself.

This renames the group to `rustdoc::all` for consistency with `clippy::all` and the rest of the rustdoc lints.

Follow-up to #80527.
r? ``@Manishearth``
This commit is contained in:
Yuki Okushi 2021-03-14 13:07:32 +09:00 committed by GitHub
commit 33614023a1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 58 additions and 33 deletions

View file

@ -346,6 +346,7 @@ fn register_builtins(store: &mut LintStore, no_interleave_lints: bool) {
"intra_doc_link_resolution_failure", "intra_doc_link_resolution_failure",
"use `rustdoc::broken_intra_doc_links` instead", "use `rustdoc::broken_intra_doc_links` instead",
); );
store.register_removed("rustdoc", "use `rustdoc::all` instead");
store.register_removed("unknown_features", "replaced by an error"); store.register_removed("unknown_features", "replaced by an error");
store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate"); store.register_removed("unsigned_negation", "replaced by negate_unsigned feature gate");

View file

@ -175,8 +175,8 @@ crate fn register_lints(_sess: &Session, lint_store: &mut LintStore) {
lint_store.register_lints(&**RUSTDOC_LINTS); lint_store.register_lints(&**RUSTDOC_LINTS);
lint_store.register_group( lint_store.register_group(
true, true,
"rustdoc", "rustdoc::all",
None, Some("rustdoc"),
RUSTDOC_LINTS.iter().map(|&lint| LintId::of(lint)).collect(), RUSTDOC_LINTS.iter().map(|&lint| LintId::of(lint)).collect(),
); );
for lint in &*RUSTDOC_LINTS { for lint in &*RUSTDOC_LINTS {

View file

@ -1,7 +1,7 @@
// compile-flags: -Z unstable-options --check // compile-flags: -Z unstable-options --check
#![deny(missing_docs)] #![deny(missing_docs)]
#![deny(rustdoc)] #![deny(rustdoc::all)]
//! ```rust,testharness //! ```rust,testharness
//~^ ERROR //~^ ERROR

View file

@ -19,9 +19,9 @@ LL | pub fn foo() {}
note: the lint level is defined here note: the lint level is defined here
--> $DIR/check-fail.rs:4:9 --> $DIR/check-fail.rs:4:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::missing_doc_code_examples)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::missing_doc_code_examples)]` implied by `#[deny(rustdoc::all)]`
error: unknown attribute `testharness`. Did you mean `test_harness`? error: unknown attribute `testharness`. Did you mean `test_harness`?
--> $DIR/check-fail.rs:6:1 --> $DIR/check-fail.rs:6:1
@ -35,9 +35,9 @@ LL | | //! ```
note: the lint level is defined here note: the lint level is defined here
--> $DIR/check-fail.rs:4:9 --> $DIR/check-fail.rs:4:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::invalid_codeblock_attributes)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::invalid_codeblock_attributes)]` implied by `#[deny(rustdoc::all)]`
= help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function = help: the code block will either not be tested if not marked as a rust one or the code will be wrapped inside a main function
error: unknown attribute `testharness`. Did you mean `test_harness`? error: unknown attribute `testharness`. Did you mean `test_harness`?

View file

@ -4,7 +4,7 @@
#![warn(missing_docs)] #![warn(missing_docs)]
//~^ WARN //~^ WARN
//~^^ WARN //~^^ WARN
#![warn(rustdoc)] #![warn(rustdoc::all)]
pub fn foo() {} pub fn foo() {}
//~^ WARN //~^ WARN

View file

@ -4,7 +4,7 @@ warning: missing documentation for the crate
LL | / #![warn(missing_docs)] LL | / #![warn(missing_docs)]
LL | | LL | |
LL | | LL | |
LL | | #![warn(rustdoc)] LL | | #![warn(rustdoc::all)]
LL | | LL | |
LL | | pub fn foo() {} LL | | pub fn foo() {}
| |_______________^ | |_______________^
@ -26,9 +26,9 @@ warning: no documentation found for this crate's top-level module
note: the lint level is defined here note: the lint level is defined here
--> $DIR/check.rs:7:9 --> $DIR/check.rs:7:9
| |
LL | #![warn(rustdoc)] LL | #![warn(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[warn(rustdoc::missing_crate_level_docs)]` implied by `#[warn(rustdoc)]` = note: `#[warn(rustdoc::missing_crate_level_docs)]` implied by `#[warn(rustdoc::all)]`
= help: The following guide may be of use: = help: The following guide may be of use:
https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html https://doc.rust-lang.org/nightly/rustdoc/how-to-write-documentation.html
@ -38,7 +38,7 @@ warning: missing code example in this documentation
LL | / #![warn(missing_docs)] LL | / #![warn(missing_docs)]
LL | | LL | |
LL | | LL | |
LL | | #![warn(rustdoc)] LL | | #![warn(rustdoc::all)]
LL | | LL | |
LL | | pub fn foo() {} LL | | pub fn foo() {}
| |_______________^ | |_______________^
@ -46,9 +46,9 @@ LL | | pub fn foo() {}
note: the lint level is defined here note: the lint level is defined here
--> $DIR/check.rs:7:9 --> $DIR/check.rs:7:9
| |
LL | #![warn(rustdoc)] LL | #![warn(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[warn(rustdoc::missing_doc_code_examples)]` implied by `#[warn(rustdoc)]` = note: `#[warn(rustdoc::missing_doc_code_examples)]` implied by `#[warn(rustdoc::all)]`
warning: missing code example in this documentation warning: missing code example in this documentation
--> $DIR/check.rs:9:1 --> $DIR/check.rs:9:1

View file

@ -4,7 +4,7 @@
//! println!("sup"); //! println!("sup");
//! ``` //! ```
#![deny(rustdoc)] #![deny(rustdoc::all)]
/// what up, let's make an [error] /// what up, let's make an [error]
/// ///

View file

@ -7,9 +7,9 @@ LL | /// wait, this doesn't have a doctest?
note: the lint level is defined here note: the lint level is defined here
--> $DIR/lint-group.rs:7:9 --> $DIR/lint-group.rs:7:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::missing_doc_code_examples)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::missing_doc_code_examples)]` implied by `#[deny(rustdoc::all)]`
error: documentation test in private item error: documentation test in private item
--> $DIR/lint-group.rs:19:1 --> $DIR/lint-group.rs:19:1
@ -24,9 +24,9 @@ LL | | /// ```
note: the lint level is defined here note: the lint level is defined here
--> $DIR/lint-group.rs:7:9 --> $DIR/lint-group.rs:7:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::private_doc_tests)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::private_doc_tests)]` implied by `#[deny(rustdoc::all)]`
error: missing code example in this documentation error: missing code example in this documentation
--> $DIR/lint-group.rs:26:1 --> $DIR/lint-group.rs:26:1
@ -43,9 +43,9 @@ LL | /// what up, let's make an [error]
note: the lint level is defined here note: the lint level is defined here
--> $DIR/lint-group.rs:7:9 --> $DIR/lint-group.rs:7:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::broken_intra_doc_links)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::broken_intra_doc_links)]` implied by `#[deny(rustdoc::all)]`
= help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]` = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
error: unclosed HTML tag `unknown` error: unclosed HTML tag `unknown`
@ -57,9 +57,9 @@ LL | /// <unknown>
note: the lint level is defined here note: the lint level is defined here
--> $DIR/lint-group.rs:7:9 --> $DIR/lint-group.rs:7:9
| |
LL | #![deny(rustdoc)] LL | #![deny(rustdoc::all)]
| ^^^^^^^ | ^^^^^^^^^^^^
= note: `#[deny(rustdoc::invalid_html_tags)]` implied by `#[deny(rustdoc)]` = note: `#[deny(rustdoc::invalid_html_tags)]` implied by `#[deny(rustdoc::all)]`
error: aborting due to 5 previous errors error: aborting due to 5 previous errors

View file

@ -12,6 +12,9 @@
#![deny(non_autolinks)] #![deny(non_autolinks)]
//~^ ERROR renamed to `rustdoc::non_autolinks` //~^ ERROR renamed to `rustdoc::non_autolinks`
#![deny(rustdoc)]
//~^ ERROR removed: use `rustdoc::all` instead
// Explicitly don't try to handle this case, it was never valid // Explicitly don't try to handle this case, it was never valid
#![deny(rustdoc::intra_doc_link_resolution_failure)] #![deny(rustdoc::intra_doc_link_resolution_failure)]
//~^ ERROR unknown lint //~^ ERROR unknown lint

View file

@ -34,13 +34,19 @@ error: lint `non_autolinks` has been renamed to `rustdoc::non_autolinks`
LL | #![deny(non_autolinks)] LL | #![deny(non_autolinks)]
| ^^^^^^^^^^^^^ help: use the new name: `rustdoc::non_autolinks` | ^^^^^^^^^^^^^ help: use the new name: `rustdoc::non_autolinks`
error: lint `rustdoc` has been removed: use `rustdoc::all` instead
--> $DIR/unknown-renamed-lints.rs:15:9
|
LL | #![deny(rustdoc)]
| ^^^^^^^
error: unknown lint: `rustdoc::intra_doc_link_resolution_failure` error: unknown lint: `rustdoc::intra_doc_link_resolution_failure`
--> $DIR/unknown-renamed-lints.rs:16:9 --> $DIR/unknown-renamed-lints.rs:19:9
| |
LL | #![deny(rustdoc::intra_doc_link_resolution_failure)] LL | #![deny(rustdoc::intra_doc_link_resolution_failure)]
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
error: Compilation failed, aborting rustdoc error: Compilation failed, aborting rustdoc
error: aborting due to 6 previous errors error: aborting due to 7 previous errors

View file

@ -0,0 +1,5 @@
// check-pass
// compile-flags: --crate-type lib
#![deny(rustdoc)]
//~^ WARNING removed: use `rustdoc::all`
#![deny(rustdoc::all)] // has no effect when run with rustc directly

View file

@ -0,0 +1,10 @@
warning: lint `rustdoc` has been removed: use `rustdoc::all` instead
--> $DIR/rustdoc-group.rs:3:9
|
LL | #![deny(rustdoc)]
| ^^^^^^^
|
= note: `#[warn(renamed_and_removed_lints)]` on by default
warning: 1 warning emitted