mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

document ./x.py fmt

This commit is contained in:
Mark Mansi 2020-02-18 11:36:57 -06:00 committed by Who? Me?!
parent 9c939f4df0
commit 209fa47503
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/tests/intro.md
View File

@ -63,6 +63,15 @@ including:
Example: `./x.py test src/tools/tidy` 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 - **Unit tests** – The Rust standard library and many of the Rust packages
include typical Rust `#[test]` unittests. Under the hood, `x.py` will run include typical Rust `#[test]` unittests. Under the hood, `x.py` will run
`cargo test` on each package to run all the tests. `cargo test` on each package to run all the tests.