Commit 84bcd9e

authored

Merge pull request #2588 from fmease/to-crash-tests

Rename "crashes tests" to "crash tests"

2 parents 659b98a + 2d632c7 commit 84bcd9eCopy full SHA for 84bcd9e

File tree

3 files changed

+10

-9

lines changed

src
- fuzzing.md
- tests
  - best-practices.md
  - compiletest.md

3 files changed

+10

-9

lines changed

`‎src/fuzzing.md`

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -90,14 +90,15 @@ Here are a few things you can do to help the Rust project after filing an ICE.`
`90`	`90`	`triggering the ICE, such as syntax errors or borrow-checking errors`
`91`	`91`	`- Minimize the test case (see below). If successful, you can label the`
`92`	`92`	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].`
`94`	`94`	`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.`
`96`	`97`
`97`	`98`	`See also [applying and removing labels][labeling].`
`98`	`99`
`99`	`100`	`[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`
`101`	`102`	`[labeling]: https://forge.rust-lang.org/release/issue-triaging.html#applying-and-removing-labels`
`102`	`103`
`103`	`104`	`## Minimization`

`‎src/tests/best-practices.md`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ related tests.`
`71`	`71`	`> //! Regression test for <https://github.com/rust-lang/rust/issues/123456>.`
`72`	`72`	> ```
`73`	`73`	`>`
`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`
`75`	`75`	`> tests are named only after issue numbers because its purpose is to track`
`76`	`76`	`> snippets from which issues no longer ICE/crash, and they would either be`
`77`	`77`	`> removed or converted into proper ui/other tests in the fix PRs.`
`@@ -199,4 +199,4 @@ See [LLVM FileCheck guide][FileCheck] for details.`
`199`	`199`	`[compiletest directives]: ./directives.md`
`200`	`200`	[`run-make`]: ./compiletest.md#run-make-tests
`201`	`201`	`[FileCheck]: https://llvm.org/docs/CommandGuide/FileCheck.html`
`202`		`-[crashes tests]: ./compiletest.md#crashes-tests`
	`202`	`+[crash tests]: ./compiletest.md#crash-tests`

`‎src/tests/compiletest.md`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ The following test suites are available, with links for more information:`
`72`	`72`	\| [`mir-opt`](#mir-opt-tests) \| Check MIR generation and optimizations \|
`73`	`73`	\| [`coverage`](#coverage-tests) \| Check coverage instrumentation \|
`74`	`74`	\| [`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 \|
`76`	`76`
`77`	`77`	`### General purpose test suite`
`78`	`78`
@@ -557,7 +557,7 @@ only running the main `coverage` suite.
`557`	`557`	[`src/tools/coverage-dump`]: https://github.com/rust-lang/rust/tree/master/src/tools/coverage-dump
`558`	`558`	[`tests/coverage-run-rustdoc`]: https://github.com/rust-lang/rust/tree/master/tests/coverage-run-rustdoc
`559`	`559`
`560`		`-### Crashes tests`
	`560`	`+### Crash tests`
`561`	`561`
`562`	`562`	[`tests/crashes`] serve as a collection of tests that are expected to cause the
`563`	`563`	`compiler to ICE, panic or crash in some other way, so that accidental fixes are`
`@@ -580,13 +580,13 @@ recommended to include test cases from several issues in a single PR.`
`580`	`580`	When you do so, each issue number should be noted in the file name (`12345.rs`
`581`	`581`	should suffice) and also inside the file by means of a `//@ known-bug: #12345`
`582`	`582`	directive. Please [label][labeling] the relevant issues with `S-bug-has-test`
`583`		`-afterwards.`
	`583`	`+once your PR is merged.`
`584`	`584`
`585`	`585`	`If you happen to fix one of the crashes, please move it to a fitting`
`586`	`586`	subdirectory in `tests/ui` and give it a meaningful name. Please add a doc
`587`	`587`	`comment at the top of the file explaining why this test exists, even better if`
`588`	`588`	`you can briefly explain how the example causes rustc to crash previously and`
`589`		`-what was done to prevent rustc to ICE/panic/crash.`
	`589`	`+what was done to prevent rustc to ICE / panic / crash.`
`590`	`590`
`591`	`591`	`Adding`
`592`	`592`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 84bcd9e

File tree

3 files changed

3 files changed

`‎src/fuzzing.md`

`‎src/tests/best-practices.md`

`‎src/tests/compiletest.md`

0 commit comments