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

Update ./x.py tidy testing documentation (#607) 

* update all docs to use ./x.py test tidy syntax
This commit is contained in:
Chris Simpkins 2020-03-09 23:02:24 -04:00 committed by GitHub
parent fd08d16f3d
commit 3524cac4b4
4 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/conventions.md
View File

@ -12,7 +12,7 @@ at the moment, however, it follows a rather more *chaotic* style. We
do have some mandatory formatting conventions, which are automatically do have some mandatory formatting conventions, which are automatically
enforced by a script we affectionately call the "tidy" script. The enforced by a script we affectionately call the "tidy" script. The
tidy script runs automatically when you do `./x.py test` and can be run tidy script runs automatically when you do `./x.py test` and can be run
in isolation with `./x.py test src/tools/tidy`. in isolation with `./x.py test tidy`.
[fmt]: https://github.com/rust-lang-nursery/fmt-rfcs [fmt]: https://github.com/rust-lang-nursery/fmt-rfcs

2
src/diagnostics/diagnostic-codes.md
View File

@ -12,7 +12,7 @@ code. This is a bit tricky since the codes are defined in various crates. To do
it, run this obscure command: it, run this obscure command:
``` ```
./x.py test --stage 0 src/tools/tidy ./x.py test --stage 0 tidy
``` ```
This will invoke the tidy script, which generally checks that your code obeys This will invoke the tidy script, which generally checks that your code obeys

4
src/tests/intro.md
View File

@ -61,7 +61,7 @@ including:
There is more information in the There is more information in the
[section on coding conventions](../conventions.html#formatting). [section on coding conventions](../conventions.html#formatting).
Example: `./x.py test src/tools/tidy` Example: `./x.py test tidy`
- **Formatting** – Rustfmt is integrated with the build system to enforce - **Formatting** – Rustfmt is integrated with the build system to enforce
uniform style across the compiler. In the CI, we check that the formatting uniform style across the compiler. In the CI, we check that the formatting
@ -73,7 +73,7 @@ including:
Example: `./x.py fmt` runs rustfmt on the codebase. Example: `./x.py fmt` runs rustfmt on the codebase.
Example: `./x.py test src/tools/tidy --bless` does formatting before doing Example: `./x.py test tidy --bless` does formatting before doing
other tidy checks. other tidy checks.
- **Unit tests** – The Rust standard library and many of the Rust packages - **Unit tests** – The Rust standard library and many of the Rust packages

6
src/tests/running.md
View File

@ -63,7 +63,7 @@ Likewise, you can test a single file by passing its path:
### Run only the tidy script ### Run only the tidy script
```bash ```bash
./x.py test src/tools/tidy ./x.py test tidy
``` ```
### Run tests on the standard library ### Run tests on the standard library
@ -72,10 +72,10 @@ Likewise, you can test a single file by passing its path:
./x.py test src/libstd ./x.py test src/libstd
``` ```
### Run tests on the standard library and run the tidy script ### Run the tidy script and tests on the standard library
```bash ```bash
./x.py test src/libstd src/tools/tidy ./x.py test tidy src/libstd
``` ```
### Run tests on the standard library using a stage 1 compiler ### Run tests on the standard library using a stage 1 compiler