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.
This commit is contained in:
Jonathan Brouwer 2025-12-22 07:58:48 +01:00 committed by GitHub
commit 43f270a0ef
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,25 +1,9 @@
This is serves as a collection of crashes so that accidental ICE fixes are tracked.
This was formally done at https://github.com/rust-lang/glacier but doing it inside
the rustc testsuite is more convenient.
Documentation on crash tests is at https://rustc-dev-guide.rust-lang.org/tests/compiletest#crash-tests.
It is imperative that a test in the suite causes an internal compiler error/panic
or makes rustc crash in some other way.
A test will "pass" if rustc exits with something other than 1 or 0.
Alternatively, you can build the documentation from this repository:
When adding crashes from https://github.com/rust-lang/rust/issues, the
issue number should be noted in the file name (12345.rs should suffice)
and also inside the file via `//@ known-bug #4321` if possible.
```console
mdbook serve --open src/doc/rustc-dev-guide
```
If you happen to fix one of the crashes, please move it to a fitting
subdirectory in `tests/ui` and give it a meaningful name.
Also please add a doc comment at the top of the file explaining why
this test exists. :)
Adding
Fixes #NNNNN
Fixes #MMMMM
to the description of your pull request will ensure the
corresponding tickets will be closed automatically upon merge.
The ticket ids can be found in the file name or the `known-bug` annotation
inside the testfile.
Please do not re-report any crashes that you find here!
The documentation will then be available at http://localhost:3000/tests/compiletest.html#crash-tests.