Validate lint docs separately. #79522
Merged
Conversation
This file contains 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 helps avoid needing to pass so many parameters around.
|
(rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
cc @petrochenkov FYI |
jyn514
added
T-bootstrap
src/tools/lint-docs/src/lib.rs
Outdated
| Some((lineno, line)) => { | ||
| let line = line.trim(); | ||
| if line.starts_with("/// ") { | ||
| doc_lines.push(line.trim()[4..].to_string()); |
There was a problem hiding this comment.
FWIW strip_prefix would probably be a little better. But I guess we need the trim and to_string either way.
There was a problem hiding this comment.
Yea, I think the strip_prefix is better. I'm not sure why, but I keep forgetting about it.
src/tools/lint-docs/src/main.rs
Outdated
| " | ||
| This error was generated by the lint-docs tool. | ||
| This tool extracts documentation for lints from the source code and places | ||
| them in the rustc book. See the declare_lint! documentation for an example of |
There was a problem hiding this comment.
Can we link to the documentation or list the file of declare_lint!? I guess it's a macro_rules! declare_lint grep away, but that's not the most intuitive thing I imagine.
This will hopefully help users figure out what was wrong and how to fix it.
ehuss
force-pushed
the
lint-check-validate
branch
from
8a90483
to
a90fdfc
Compare
|
@bors r=Mark-Simulacrum |
|
📌 Commit a90fdfc has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Nov 30, 2020
…imulacrum Validate lint docs separately. This addresses some concerns raised in rust-lang#76549 (comment) about errors with the lint docs being confusing and cumbersome. Errors from validating the lint documentation were being generated during `x.py doc` (and `x.py dist`), since extraction and validation are being done in a single step. This changes it so that extraction and validation are separated, so that `x.py doc` will not error if there is a validation problem, and tests are moved to `x.py test src/tools/lint-docs`. This includes the following changes: * Separate validation to `x.py test`. * Added some more documentation on how to more easily modify and test the docs. * Added more help to the error messages to hopefully provide more information on how to fix things. The first commit just moves the code around, so you may consider looking at the other commits for a smaller diff.
m-ou-se
added a commit
to m-ou-se/rust
that referenced
this pull request
Dec 1, 2020
…imulacrum Validate lint docs separately. This addresses some concerns raised in rust-lang#76549 (comment) about errors with the lint docs being confusing and cumbersome. Errors from validating the lint documentation were being generated during `x.py doc` (and `x.py dist`), since extraction and validation are being done in a single step. This changes it so that extraction and validation are separated, so that `x.py doc` will not error if there is a validation problem, and tests are moved to `x.py test src/tools/lint-docs`. This includes the following changes: * Separate validation to `x.py test`. * Added some more documentation on how to more easily modify and test the docs. * Added more help to the error messages to hopefully provide more information on how to fix things. The first commit just moves the code around, so you may consider looking at the other commits for a smaller diff.
This was referenced Dec 1, 2020
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 1, 2020
Rollup of 11 pull requests Successful merges: - rust-lang#79038 (Change ui test that are run-pass and that do not test the compiler to library tests) - rust-lang#79184 (Stop adding '*' at the end of slice and str typenames for MSVC case) - rust-lang#79227 (Remove const_fn_feature_flags test) - rust-lang#79444 (Move const ip in ui test to unit test) - rust-lang#79522 (Validate lint docs separately.) - rust-lang#79525 (Add -Z normalize-docs and enable it for compiler docs) - rust-lang#79527 (Move intra-doc link tests into a subdirectory) - rust-lang#79548 (Show since when a function is const in stdlib) - rust-lang#79568 (update Miri) - rust-lang#79573 (Update with status for various NetBSD ports.) - rust-lang#79583 (Update books) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 27, 2020
…Simulacrum lint-docs: Warn on missing lint when documenting. In rust-lang#79522, I missed converting one of the errors to a warning, in the situation where a lint is missing. This was unearthed by the renaming of overlapping-patterns (rust-lang#78242). This will still be validated during the test phase.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This addresses some concerns raised in #76549 (comment) about errors with the lint docs being confusing and cumbersome. Errors from validating the lint documentation were being generated during
x.py doc(andx.py dist), since extraction and validation are being done in a single step. This changes it so that extraction and validation are separated, so thatx.py docwill not error if there is a validation problem, and tests are moved tox.py test src/tools/lint-docs.This includes the following changes:
x.py test.The first commit just moves the code around, so you may consider looking at the other commits for a smaller diff.