Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ./x.py tidy testing documentation #607

Merged
merged 2 commits into from
Mar 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/diagnostics/diagnostic-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/tests/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions src/tests/running.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down