Skip to content

Add some docs for tidy #129368

@jieyouxu

Description

@jieyouxu

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)

Metadata

Metadata

Assignees

Labels

A-docsArea: 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.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions