Skip to content
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

The {{produces}} special marker isn't explained in lint docs #2114

Open
jieyouxu opened this issue Nov 2, 2024 · 2 comments
Open

The {{produces}} special marker isn't explained in lint docs #2114

jieyouxu opened this issue Nov 2, 2024 · 2 comments
Labels
A-lints Area: lints C-enhancement Category: enhancement E-easy Difficulty: might be a good place for a beginner E-needs-investigation Call for participation: this issue needs further investigation T-bootstrap Relevant to bootstrap team T-compiler Relevant to compiler team

Comments

@jieyouxu
Copy link
Member

jieyouxu commented Nov 2, 2024

Lint docs e.g. in compiler/rustc_lint_defs/src/builtin.rs have this special {{produces}} annotation, we should explain what it does (I haven't quite looked at the exact behavior).

I think it's to generate a snapshot of the lint output for use by lint docs book itself.

@jieyouxu jieyouxu added A-lints Area: lints C-enhancement Category: enhancement E-medium Difficulty: might require some prior knowledge or code reading T-compiler Relevant to compiler team labels Nov 2, 2024
@jieyouxu jieyouxu changed the title The {{produces}} special marker isn't explain in lint docs The {{produces}} special marker isn't explained in lint docs Nov 2, 2024
@jieyouxu jieyouxu added T-bootstrap Relevant to bootstrap team E-needs-investigation Call for participation: this issue needs further investigation labels Nov 2, 2024
@jieyouxu
Copy link
Member Author

jieyouxu commented Nov 2, 2024

... I think I vaguely recall maybe a lint-docs bootstrap tool? Not sure.

@ehuss
Copy link
Contributor

ehuss commented Nov 2, 2024

The format for a lint is described in the declare_lint docs. It seems like a good idea to link to that from https://rustc-dev-guide.rust-lang.org/diagnostics.html#declaring-a-lint.

@jieyouxu jieyouxu added E-easy Difficulty: might be a good place for a beginner and removed E-medium Difficulty: might require some prior knowledge or code reading labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-lints Area: lints C-enhancement Category: enhancement E-easy Difficulty: might be a good place for a beginner E-needs-investigation Call for participation: this issue needs further investigation T-bootstrap Relevant to bootstrap team T-compiler Relevant to compiler team
Projects
None yet
Development

No branches or pull requests

2 participants