Skip to content

Commit 43f270a

Browse files
Rollup merge of #150109 - tshepang:patch-1, r=jieyouxu
crash test readme: point to rustc-dev-guide There is information that is duplicated here and in rustc-dev-guide, and the latter is more comprehensive, so point there.
2 parents e1f41dc + e17c2f3 commit 43f270a

File tree

1 file changed

+6
-22
lines changed

1 file changed

+6
-22
lines changed

tests/crashes/README.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,9 @@
1-
This is serves as a collection of crashes so that accidental ICE fixes are tracked.
2-
This was formally done at https://github.com/rust-lang/glacier but doing it inside
3-
the rustc testsuite is more convenient.
1+
Documentation on crash tests is at https://rustc-dev-guide.rust-lang.org/tests/compiletest#crash-tests.
42

5-
It is imperative that a test in the suite causes an internal compiler error/panic
6-
or makes rustc crash in some other way.
7-
A test will "pass" if rustc exits with something other than 1 or 0.
3+
Alternatively, you can build the documentation from this repository:
84

9-
When adding crashes from https://github.com/rust-lang/rust/issues, the
10-
issue number should be noted in the file name (12345.rs should suffice)
11-
and also inside the file via `//@ known-bug #4321` if possible.
5+
```console
6+
mdbook serve --open src/doc/rustc-dev-guide
7+
```
128

13-
If you happen to fix one of the crashes, please move it to a fitting
14-
subdirectory in `tests/ui` and give it a meaningful name.
15-
Also please add a doc comment at the top of the file explaining why
16-
this test exists. :)
17-
Adding
18-
Fixes #NNNNN
19-
Fixes #MMMMM
20-
to the description of your pull request will ensure the
21-
corresponding tickets will be closed automatically upon merge.
22-
The ticket ids can be found in the file name or the `known-bug` annotation
23-
inside the testfile.
24-
25-
Please do not re-report any crashes that you find here!
9+
The documentation will then be available at http://localhost:3000/tests/compiletest.html#crash-tests.

0 commit comments

Comments
 (0)