Skip to content

Commit 23775eb

Browse files
committed
Docs for needs-forced-clang-based-tests (was needs-matching-clang)
1 parent 9179f48 commit 23775eb

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/tests/headers.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,12 @@ The following header commands will check LLVM support:
173173
* `ignore-llvm-version: 7.0 - 9.9.9` — ignores LLVM versions in a range (inclusive)
174174
* `needs-llvm-components: powerpc` — ignores if the specific LLVM component was not built.
175175
Note: The test will fail on CI (when `COMPILETEST_REQUIRE_ALL_LLVM_COMPONENTS` is set) if the component does not exist.
176-
* `needs-matching-clang` — ignores if the version of clang does not match the
177-
LLVM version of rustc.
178-
These tests are always ignored unless a special environment variable,
179-
`RUSTBUILD_FORCE_CLANG_BASED_TESTS`, is set
180-
(which is only done in one CI job [`x86_64-gnu-debug`]).
176+
* `needs-forced-clang-based-tests`
177+
test is ignored unless the environment variable `RUSTBUILD_FORCE_CLANG_BASED_TESTS`
178+
is set, which enables building clang alongside LLVM
179+
- This is only set in one CI job ([`x86_64-gnu-debug`]), which only runs a tiny
180+
subset of `run-make` tests. Other tests with this header will not run at all,
181+
which is usually not what you want.
181182

182183
See also [Debuginfo tests](compiletest.md#debuginfo-tests) for headers for
183184
ignoring debuggers.

0 commit comments

Comments
 (0)