Skip to content

Commit 521735b

Browse files
authored
Rollup merge of #146460 - simp4t7:add-tidy-readme, r=clubby789
Add tidy readme This PR adds a Readme to `src/tools/tidy`. Basically just explains how `tidy` works and covers all of tidy's checks, directives, and how to use tidy. I tried to add a bit more detail on some of the options like `--extra-checks` and the style directives that aren't really documented well elsewhere. Planning to link to this in the dev guide. Closes: rust-lang/rust#129368
2 parents b147866 + 43b8dee commit 521735b

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/tests/intro.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,12 @@ package tests:
7070

7171
Tidy is a custom tool used for validating source code style and formatting
7272
conventions, such as rejecting long lines. There is more information in the
73-
[section on coding conventions](../conventions.md#formatting).
73+
[section on coding conventions](../conventions.md#formatting) or the [Tidy Readme].
7474

7575
> Examples: `./x test tidy`
7676
77+
[Tidy Readme]: https://github.com/rust-lang/rust/blob/master/src/tools/tidy/Readme.md
78+
7779

7880
### Formatting
7981

0 commit comments

Comments
 (0)