Skip to content

Commit 04832fa

Browse files
committed
document ./x.py fmt
1 parent 3dd93bf commit 04832fa

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/tests/intro.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,15 @@ including:
6363

6464
Example: `./x.py test src/tools/tidy`
6565

66+
- **Formatting** – Rustfmt is integrated with the build system to enforce
67+
uniform style across the compiler. In the CI, we check that the formatting
68+
is correct.
69+
70+
Example: `./x.py fmt --check` checks formatting an exits with an error if
71+
formatting is needed.
72+
73+
Example: `./x.py fmt` runs rustfmt on the codebase.
74+
6675
- **Unit tests** – The Rust standard library and many of the Rust packages
6776
include typical Rust `#[test]` unittests. Under the hood, `x.py` will run
6877
`cargo test` on each package to run all the tests.

0 commit comments

Comments
 (0)