-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Description
We should add some docs for the tidy
tool (probably a README.md in the src/tools/tidy
directory then backlink from rustc-dev-guide). Specifically, things like:
- What is tidy
- Why do we have tidy and enforce its checks
- What checks does it perform
- Tidy directives (not to be confused with compiletest directives)
- Interactions between tidy and other tools like compiletest (e.g. revision checks and stuff)
Dylan-DPC
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-enhancementCategory: An issue proposing an enhancement or a PR with one.Category: An issue proposing an enhancement or a PR with one.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)