Description
Proposal
I would like to implement a change so that the lint documentation is automatically generated from the lint definitions.
The lint listing at https://doc.rust-lang.org/rustc/lints/listing/index.html is out of date. It requires manual maintenance, which few people bother with.
The change would be to move the documentation into the declare_lint macro. This is how clippy does it (example), and I would suggest using a similar form. Then, a simple script would be used when building the rustc book to extract the documentation and place it in the book (similar to how clippy does which is displayed on github pages here), though I would probably just retain the current formatting. Additionally, I would like to add a test to ensure the examples work as expected (generate the expected lint).
A future extension (not proposed for now), is to provide more convenient access to this documentation, similar to how errors point to the error index with the --explain flag.
Mentors or Reviewers
Process
The main points of the Major Change Process is as follows:
- File an issue describing the proposal.
- A compiler team member or contributor who is knowledgeable in the area can second by writing
@rustbot second.- Finding a "second" suffices for internal changes. If however you are proposing a new public-facing feature, such as a
-C flag, then full team check-off is required. - Compiler team members can initiate a check-off via
@rfcbot fcp mergeon either the MCP or the PR.
- Finding a "second" suffices for internal changes. If however you are proposing a new public-facing feature, such as a
- Once an MCP is seconded, the Final Comment Period begins. If no objections are raised after 10 days, the MCP is considered approved.
You can read more about Major Change Proposals on forge.
Comments
This issue is not meant to be used for technical discussion. There is a Zulip stream for that. Use this issue to leave procedural comments, such as volunteering to review, indicating that you second the proposal (or third, etc), or raising a concern that you would like to be addressed.