diff options
| author | Who? Me?! <mark-i-m@users.noreply.github.com> | 2018-06-02 16:06:00 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-06-02 16:06:00 -0500 |
| commit | 47bb51958ae6645919db54e80c9b455ad51448a4 (patch) | |
| tree | f112be377295c1fc84c64abe86bafd9f2fd5c735 /src/doc | |
| parent | d96879052968d2cc645668f4e0018ddfac499d01 (diff) | |
| download | rust-47bb51958ae6645919db54e80c9b455ad51448a4.tar.gz rust-47bb51958ae6645919db54e80c9b455ad51448a4.zip | |
clarify run-rustfix compiletest header
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/adding.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/adding.md b/src/doc/rustc-dev-guide/src/tests/adding.md index 3788e7c41c5..28f4c1140ab 100644 --- a/src/doc/rustc-dev-guide/src/tests/adding.md +++ b/src/doc/rustc-dev-guide/src/tests/adding.md @@ -149,9 +149,12 @@ exhaustive. Header commands can generally be found by browsing the source. * `run-rustfix` for UI tests, indicates that the test produces - structured suggestions, which are then applied and the final - source is stored in a `.fixed` file and compiled again. The final - compilation is required to succeed. + structured suggestions. The test writer should create a `.fixed` + file, which contains the source with the suggestions applied. + When the test is run, compiletest first checks that the correct + lint/warning is generated. Then, it applies the suggestion and + compares against `.fixed` (they must match). Finally, the fixed + source is compiled, and this compilation is required to succeed. * `min-{gdb,lldb}-version` * `min-llvm-version` * `compile-pass` for UI tests, indicates that the test is |