Auto merge of rust-lang#2032 - rust-lang:gesundheit, r=oli-obk

Move test suite to ui tests and bless stderr output

fixes rust-lang#2027

* [ ] //~ annotations should check that the error happens on their line
* [x] document all the things

Author: bors

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribution Guide
 
-If you want to hack on miri yourself, great!  Here are some resources you might
+If you want to hack on Miri yourself, great!  Here are some resources you might
 find useful.
 
 ## Getting started
@@ -89,6 +89,20 @@ MIRI_LOG=rustc_mir::interpret=info,miri::stacked_borrows ./miri run tests/run-pa
 In addition, you can set `MIRI_BACKTRACE=1` to get a backtrace of where an
 evaluation error was originally raised.
 
+#### UI testing
+
+We use ui-testing in Miri, meaning we generate `.stderr` and `.stdout` files for the output
+produced by Miri. You can use `./miri bless` to automatically (re)generate these files when
+you add new tests or change how Miri presents certain output.
+
+Note that when you also use `MIRIFLAGS` to change optimizations and similar, the ui output
+will change in unexpected ways. In order to still be able
+to run the other checks while ignoring the ui output, use `MIRI_SKIP_UI_CHECKS=1 ./miri test`.
+
+For more info on how to configure ui tests see [the documentation on the ui test crate][ui_test]
+
+[ui_test]: ui_test/README.md
+
 ### Testing `cargo miri`
 
 Working with the driver directly gives you full control, but you also lose all
@@ -183,15 +197,15 @@ A big part of the Miri driver lives in rustc, so working on Miri will sometimes
 require using a locally built rustc. The bug you want to fix may actually be on
 the rustc side, or you just need to get more detailed trace of the execution
 than what is possible with release builds -- in both cases, you should develop
-miri against a rustc you compiled yourself, with debug assertions (and hence
+Miri against a rustc you compiled yourself, with debug assertions (and hence
 tracing) enabled.
 
 The setup for a local rustc works as follows:
 ```sh
 # Clone the rust-lang/rust repo.
 git clone https://github.com/rust-lang/rust rustc
 cd rustc
-# Create a config.toml with defaults for working on miri.
+# Create a config.toml with defaults for working on Miri.
 ./x.py setup compiler
  # Now edit `config.toml` and under `[rust]` set `debug-assertions = true`.