Skip to content

Commit caea7ae

Browse files
nikomatsakismark-i-m
authored andcommitted
mention tidy
1 parent b502a6a commit caea7ae

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

src/conventions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
This file offers some tips on the coding conventions for rustc. This
2-
chapter covers [formatting](#f), [coding for correctness](#cc),
2+
chapter covers [formatting](#formatting), [coding for correctness](#cc),
33
[using crates from crates.io](#cio), and some tips on
44
[structuring your PR for easy review](#er).
55

6-
<a name=f>
6+
<a name=formatting>
77

88
# Formatting and the tidy script
99

src/tests/running.md

+7
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ a very long time, and anyway bors / travis will do it for you. (Often,
1313
I will run this command in the background after opening a PR that I
1414
think is done, but rarely otherwise. -nmatsakis)
1515

16+
## Tidy
17+
18+
When you run the full suite of tests via `./x.py test`, the first
19+
thing that executes is a "tidy suite" that checks for long lines and
20+
other formatting conventions. There is more information in the
21+
[section on coding conventions](../conventions.html#formatting).
22+
1623
## Running a subset of the test suites
1724

1825
When working on a specific PR, you will usually want to run a smaller

0 commit comments

Comments
 (0)