Skip to content

Commit

Permalink
Document compiletest directives ignore-coverage-map and `ignore-cov…
Browse files Browse the repository at this point in the history
…erage-run` (#2094)
  • Loading branch information
Zalathar authored Oct 9, 2024
1 parent 2150561 commit 971f809
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/tests/compiletest.md
Original file line number Diff line number Diff line change
Expand Up @@ -464,8 +464,9 @@ Each mode also has an alias to run the coverage tests in just that mode:
./x test coverage-map -- tests/coverage/if.rs # runs the specified test in "coverage-map" mode only
```

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

#### `coverage-map` suite

Expand Down
2 changes: 2 additions & 0 deletions src/tests/directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ Some examples of `X` in `ignore-X` or `only-X`:
- When particular debugger versions are matched: `ignore-gdb-version`
- Specific [compare modes]: `compare-mode-polonius`, `compare-mode-chalk`,
`compare-mode-split-dwarf`, `compare-mode-split-dwarf-single`
- The two different test modes used by coverage tests:
`ignore-coverage-map`, `ignore-coverage-run`

The following directives will check rustc build settings and target
settings:
Expand Down

0 comments on commit 971f809

Please sign in to comment.