From 209fa47503557843bc25471ece5a240d2500567d Mon Sep 17 00:00:00 2001 From: Mark Mansi Date: Tue, 18 Feb 2020 11:36:57 -0600 Subject: [PATCH] document ./x.py fmt --- src/tests/intro.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/tests/intro.md b/src/tests/intro.md index 4572d23c..eb8aec80 100644 --- a/src/tests/intro.md +++ b/src/tests/intro.md @@ -63,6 +63,15 @@ including: Example: `./x.py test src/tools/tidy` +- **Formatting** – Rustfmt is integrated with the build system to enforce + uniform style across the compiler. In the CI, we check that the formatting + is correct. + + Example: `./x.py fmt --check` checks formatting an exits with an error if + formatting is needed. + + Example: `./x.py fmt` runs rustfmt on the codebase. + - **Unit tests** – The Rust standard library and many of the Rust packages include typical Rust `#[test]` unittests. Under the hood, `x.py` will run `cargo test` on each package to run all the tests.