Skip to content

Commit 7a4b728

Browse files
committed
Rename "crashes tests" to "crash tests"
1 parent 519854f commit 7a4b728

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

src/doc/rustc-dev-guide/src/fuzzing.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,15 @@ Here are a few things you can do to help the Rust project after filing an ICE.
9090
triggering the ICE, such as syntax errors or borrow-checking errors
9191
- Minimize the test case (see below). If successful, you can label the
9292
issue with `S-has-mcve`. Otherwise, you can apply `E-needs-mcve`.
93-
- Add the minimal test case to the rust-lang/rust repo as a [crashes test].
93+
- Add the minimal test case to the rust-lang/rust repo as a [crash test].
9494
While you're at it, consider including other "untracked" crashes in your PR.
95-
Please don't forget to mark your issue with `S-bug-has-test` afterwards.
95+
Please don't forget to mark all relevant issues with `S-bug-has-test` once
96+
your PR is merged.
9697

9798
See also [applying and removing labels][labeling].
9899

99100
[bisect]: https://rust-lang.github.io/cargo-bisect-rustc/
100-
[crashes test]: tests/compiletest.html#crashes-tests
101+
[crash test]: tests/compiletest.html#crash-tests
101102
[labeling]: https://forge.rust-lang.org/release/issue-triaging.html#applying-and-removing-labels
102103

103104
## Minimization

src/doc/rustc-dev-guide/src/tests/best-practices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ related tests.
7171
> //! Regression test for <https://github.com/rust-lang/rust/issues/123456>.
7272
> ```
7373
>
74-
> One exception to this rule is [crashes tests]: there it is canonical that
74+
> One exception to this rule is [crash tests]: there it is canonical that
7575
> tests are named only after issue numbers because its purpose is to track
7676
> snippets from which issues no longer ICE/crash, and they would either be
7777
> removed or converted into proper ui/other tests in the fix PRs.
@@ -199,4 +199,4 @@ See [LLVM FileCheck guide][FileCheck] for details.
199199
[compiletest directives]: ./directives.md
200200
[`run-make`]: ./compiletest.md#run-make-tests
201201
[FileCheck]: https://llvm.org/docs/CommandGuide/FileCheck.html
202-
[crashes tests]: ./compiletest.md#crashes-tests
202+
[crash tests]: ./compiletest.md#crash-tests

src/doc/rustc-dev-guide/src/tests/compiletest.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The following test suites are available, with links for more information:
7272
| [`mir-opt`](#mir-opt-tests) | Check MIR generation and optimizations |
7373
| [`coverage`](#coverage-tests) | Check coverage instrumentation |
7474
| [`coverage-run-rustdoc`](#coverage-tests) | `coverage` tests that also run instrumented doctests |
75-
| [`crashes`](#crashes-tests) | Check that the compiler ICEs/panics/crashes on certain inputs to catch accidental fixes |
75+
| [`crashes`](#crash-tests) | Check that the compiler ICEs/panics/crashes on certain inputs to catch accidental fixes |
7676

7777
### General purpose test suite
7878

@@ -550,7 +550,7 @@ only running the main `coverage` suite.
550550
[`src/tools/coverage-dump`]: https://github.com/rust-lang/rust/tree/master/src/tools/coverage-dump
551551
[`tests/coverage-run-rustdoc`]: https://github.com/rust-lang/rust/tree/master/tests/coverage-run-rustdoc
552552

553-
### Crashes tests
553+
### Crash tests
554554

555555
[`tests/crashes`] serve as a collection of tests that are expected to cause the
556556
compiler to ICE, panic or crash in some other way, so that accidental fixes are
@@ -573,13 +573,13 @@ recommended to include test cases from several issues in a single PR.
573573
When you do so, each issue number should be noted in the file name (`12345.rs`
574574
should suffice) and also inside the file by means of a `//@ known-bug: #12345`
575575
directive. Please [label][labeling] the relevant issues with `S-bug-has-test`
576-
afterwards.
576+
once your PR is merged.
577577

578578
If you happen to fix one of the crashes, please move it to a fitting
579579
subdirectory in `tests/ui` and give it a meaningful name. Please add a doc
580580
comment at the top of the file explaining why this test exists, even better if
581581
you can briefly explain how the example causes rustc to crash previously and
582-
what was done to prevent rustc to ICE/panic/crash.
582+
what was done to prevent rustc to ICE / panic / crash.
583583

584584
Adding
585585

0 commit comments

Comments
 (0)