diff options
| author | Mark Mansi <markm@cs.wisc.edu> | 2020-02-18 11:36:57 -0600 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2020-02-20 10:28:24 -0600 |
| commit | 6b6e7282f2f70c2525ad80909bad4f55cb166bc3 (patch) | |
| tree | 6580e946da72c7f73199e10a32be3a961ec3168f /src/doc/rustc-dev-guide | |
| parent | 043e1aaf771d3352ccf7035234800d01729bd436 (diff) | |
| download | rust-6b6e7282f2f70c2525ad80909bad4f55cb166bc3.tar.gz rust-6b6e7282f2f70c2525ad80909bad4f55cb166bc3.zip | |
document ./x.py fmt
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/intro.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/intro.md b/src/doc/rustc-dev-guide/src/tests/intro.md index 4572d23ca95..eb8aec80084 100644 --- a/src/doc/rustc-dev-guide/src/tests/intro.md +++ b/src/doc/rustc-dev-guide/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. |