Skip to content

Commit 971f809

Browse files
authored
Document compiletest directives ignore-coverage-map and ignore-coverage-run (#2094)
1 parent 2150561 commit 971f809

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

src/tests/compiletest.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -464,8 +464,9 @@ Each mode also has an alias to run the coverage tests in just that mode:
464464
./x test coverage-map -- tests/coverage/if.rs # runs the specified test in "coverage-map" mode only
465465
```
466466

467-
If a test cannot be exercised in a particular coverage mode for some reason, you
468-
can use e.g. `ignore-mode-coverage-map`.
467+
If a particular test should not be run in one of the coverage test modes for
468+
some reason, use the `//@ ignore-coverage-map` or `//@ ignore-coverage-run`
469+
directives.
469470

470471
#### `coverage-map` suite
471472

src/tests/directives.md

+2
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ Some examples of `X` in `ignore-X` or `only-X`:
145145
- When particular debugger versions are matched: `ignore-gdb-version`
146146
- Specific [compare modes]: `compare-mode-polonius`, `compare-mode-chalk`,
147147
`compare-mode-split-dwarf`, `compare-mode-split-dwarf-single`
148+
- The two different test modes used by coverage tests:
149+
`ignore-coverage-map`, `ignore-coverage-run`
148150

149151
The following directives will check rustc build settings and target
150152
settings:

0 commit comments

Comments
 (0)