Skip to content

Commit bde086e

Browse files
committed
rustc-dev-guide: document //@ ignore-auxiliary
1 parent f80260b commit bde086e

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

Diff for: src/tests/best-practices.md

+2
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,8 @@ See [compiletest directives] for a listing of directives.
175175
- For `ignore-*`/`needs-*`/`only-*` directives, unless extremely obvious,
176176
provide a brief remark on why the directive is needed. E.g. `"//@ ignore-wasi
177177
(wasi codegens the main symbol differently)"`.
178+
- When using `//@ ignore-auxiliary`, specify the corresponding main test files,
179+
e.g. ``//@ ignore-auxiliary (used by `./foo.rs`)``.
178180

179181
## FileCheck best practices
180182

Diff for: src/tests/directives.md

+3
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,9 @@ means the test won't be compiled or run.
124124
* `ignore-X` where `X` is a target detail or other criteria on which to ignore the test (see below)
125125
* `only-X` is like `ignore-X`, but will *only* run the test on that target or
126126
stage
127+
* `ignore-auxiliary` is intended for files that *participate* in one or more other
128+
main test files but that `compiletest` should not try to build the file itself.
129+
Please backlink to which main test is actually using the auxiliary file.
127130
* `ignore-test` always ignores the test. This can be used to temporarily disable
128131
a test if it is currently not working, but you want to keep it in tree to
129132
re-enable it later.

0 commit comments

Comments
 (0)