diff options
| author | Chris Simpkins <git.simpkins@gmail.com> | 2020-03-09 23:02:24 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-10 12:02:24 +0900 |
| commit | 62757a5b263b2b4e3c4a86ffe6b2875eb26aeafe (patch) | |
| tree | 93b2f0b14299da1fb4e28814d7e67ff9b0610527 /src/doc/rustc-dev-guide | |
| parent | 1b4cca3083ce914123d44a92d138c12e62f40f3e (diff) | |
| download | rust-62757a5b263b2b4e3c4a86ffe6b2875eb26aeafe.tar.gz rust-62757a5b263b2b4e3c4a86ffe6b2875eb26aeafe.zip | |
Update ./x.py tidy testing documentation (#607)
* update all docs to use ./x.py test tidy syntax
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/conventions.md | 2 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/diagnostics/diagnostic-codes.md | 2 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/intro.md | 4 | ||||
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/running.md | 6 |
4 files changed, 7 insertions, 7 deletions
diff --git a/src/doc/rustc-dev-guide/src/conventions.md b/src/doc/rustc-dev-guide/src/conventions.md index 7f7bf32e211..303eedd4ee8 100644 --- a/src/doc/rustc-dev-guide/src/conventions.md +++ b/src/doc/rustc-dev-guide/src/conventions.md @@ -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 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 -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 diff --git a/src/doc/rustc-dev-guide/src/diagnostics/diagnostic-codes.md b/src/doc/rustc-dev-guide/src/diagnostics/diagnostic-codes.md index 22d9b12c374..0e923c5e1ba 100644 --- a/src/doc/rustc-dev-guide/src/diagnostics/diagnostic-codes.md +++ b/src/doc/rustc-dev-guide/src/diagnostics/diagnostic-codes.md @@ -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: ``` -./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 diff --git a/src/doc/rustc-dev-guide/src/tests/intro.md b/src/doc/rustc-dev-guide/src/tests/intro.md index 6691f2d4e24..6a528ae4571 100644 --- a/src/doc/rustc-dev-guide/src/tests/intro.md +++ b/src/doc/rustc-dev-guide/src/tests/intro.md @@ -61,7 +61,7 @@ including: There is more information in the [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 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 test src/tools/tidy --bless` does formatting before doing + Example: `./x.py test tidy --bless` does formatting before doing other tidy checks. - **Unit tests** – The Rust standard library and many of the Rust packages diff --git a/src/doc/rustc-dev-guide/src/tests/running.md b/src/doc/rustc-dev-guide/src/tests/running.md index f5d8cbdbd03..f5c9bdb721e 100644 --- a/src/doc/rustc-dev-guide/src/tests/running.md +++ b/src/doc/rustc-dev-guide/src/tests/running.md @@ -63,7 +63,7 @@ Likewise, you can test a single file by passing its path: ### Run only the tidy script ```bash -./x.py test src/tools/tidy +./x.py test tidy ``` ### 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 ``` -### Run tests on the standard library and run the tidy script +### Run the tidy script and tests on the standard library ```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 |