From 977bf0a134609bd601343023bbb561137392f18f Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 17 Dec 2025 20:29:58 +0200 Subject: [PATCH 1/2] 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. --- tests/crashes/README.md | 26 +------------------------- 1 file changed, 1 insertion(+), 25 deletions(-) diff --git a/tests/crashes/README.md b/tests/crashes/README.md index 2dc81a115df3e..8026b7c2463c8 100644 --- a/tests/crashes/README.md +++ b/tests/crashes/README.md @@ -1,25 +1 @@ -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. - -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. - -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. - -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! +Documentation on crash tests is at https://rustc-dev-guide.rust-lang.org/tests/compiletest#crash-tests From e17c2f3eccc7436d7f94c6ed4bc8a367f4c6a7fb Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Wed, 17 Dec 2025 21:25:19 +0200 Subject: [PATCH 2/2] show how to view docs locally --- tests/crashes/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/tests/crashes/README.md b/tests/crashes/README.md index 8026b7c2463c8..a809ae798c202 100644 --- a/tests/crashes/README.md +++ b/tests/crashes/README.md @@ -1 +1,9 @@ -Documentation on crash tests is at https://rustc-dev-guide.rust-lang.org/tests/compiletest#crash-tests +Documentation on crash tests is at https://rustc-dev-guide.rust-lang.org/tests/compiletest#crash-tests. + +Alternatively, you can build the documentation from this repository: + +```console +mdbook serve --open src/doc/rustc-dev-guide +``` + +The documentation will then be available at http://localhost:3000/tests/compiletest.html#crash-tests.