Skip to content

Commit 4108747

Browse files
committed
Drop undefined footnotes
1 parent 2f06bb1 commit 4108747

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

src/tests/directives.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -65,46 +65,46 @@ not be exhaustive. Directives can generally be found by browsing the
6565
See [Controlling pass/fail
6666
expectations](ui.md#controlling-passfail-expectations).
6767

68-
| Directive | Explanation | Supported test suites | Possible values |
69-
|-----------------------------|---------------------------------------------|--------------------------------------------------|-----------------|
70-
| `check-pass` | Building (no codegen) should pass | `ui`, `crashes`, `incremental`[^inc1] | N/A |
71-
| `check-fail` | Building (no codegen) should fail | `ui`, `crashes` | N/A |
72-
| `build-pass` | Building should pass | `ui`, `crashes`, `codegen`, `incremental`[^inc1] | N/A |
73-
| `build-fail` | Building should fail | `ui`, `crashes` | N/A |
74-
| `run-pass` | Running the test binary should pass | `ui`, `crashes`, `incremental`[^inc1] | N/A |
75-
| `run-fail` | Running the test binary should fail | `ui`, `crashes` | N/A |
76-
| `ignore-pass` | Ignore `--pass` flag | `ui`, `crashes`, `codegen`, `incremental`[^inc1] | N/A |
77-
| `dont-check-failure-status` | Don't check exact failure status (i.e. `1`) | `ui`, `incremental` | N/A |
78-
| `failure-status` | Check | `ui`, `crashes` | Any `u16` |
79-
| `should-ice` | Check failure status is `101` | `coverage`, `incremental` | N/A |
80-
| `should-fail` | Compiletest self-test | All | N/A |
68+
| Directive | Explanation | Supported test suites | Possible values |
69+
|-----------------------------|---------------------------------------------|-------------------------------------------|-----------------|
70+
| `check-pass` | Building (no codegen) should pass | `ui`, `crashes`, `incremental` | N/A |
71+
| `check-fail` | Building (no codegen) should fail | `ui`, `crashes` | N/A |
72+
| `build-pass` | Building should pass | `ui`, `crashes`, `codegen`, `incremental` | N/A |
73+
| `build-fail` | Building should fail | `ui`, `crashes` | N/A |
74+
| `run-pass` | Running the test binary should pass | `ui`, `crashes`, `incremental` | N/A |
75+
| `run-fail` | Running the test binary should fail | `ui`, `crashes` | N/A |
76+
| `ignore-pass` | Ignore `--pass` flag | `ui`, `crashes`, `codegen`, `incremental` | N/A |
77+
| `dont-check-failure-status` | Don't check exact failure status (i.e. `1`) | `ui`, `incremental` | N/A |
78+
| `failure-status` | Check | `ui`, `crashes` | Any `u16` |
79+
| `should-ice` | Check failure status is `101` | `coverage`, `incremental` | N/A |
80+
| `should-fail` | Compiletest self-test | All | N/A |
8181

8282
### Controlling output snapshots and normalizations
8383

8484
See [Normalization](ui.md#normalization), [Output
8585
comparison](ui.md#output-comparison) and [Rustfix tests](ui.md#rustfix-tests)
8686
for more details.
8787

88-
| Directive | Explanation | Supported test suites | Possible values |
89-
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------------------------------------------|
90-
| `check-run-results` | Check run test binary `run-{pass,fail}` output snapshot | `ui`, `crashes`, `incremental`[^inc1] if `run-pass` | N/A |
91-
| `error-pattern` | Check that output contains a regex pattern | `ui`, `crashes`, `incremental`[^inc1] if `run-pass` | Regex |
92-
| `check-stdout` | Check `stdout` against `error-pattern`s from running test binary[^check_stdout] | `ui`, `crashes`, `incremental`[^inc1] | N/A |
93-
| `compare-output-lines-by-subset` | Check output contains the contents of the snapshot by lines opposed to checking for strict equality | `ui`, `coverage` | N/A |
94-
| `normalize-stderr-32bit` | Normalize actual stderr (for 32-bit platforms) with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental`[^inc1] | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
95-
| `normalize-stderr-64bit` | Normalize actual stderr (for 64-bit platforms) with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental`[^inc1] | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
96-
| `normalize-stderr-test` | Normalize actual stderr with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental`[^inc1] | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
97-
| `normalize-stdout-test` | Normalize actual stdout with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental`[^inc1] | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
98-
| `dont-check-compiler-stderr` | Don't check actual compiler stderr vs stderr snapshot | `ui` | N/A |
99-
| `dont-check-compiler-stdout` | Don't check actual compiler stdout vs stdout snapshot | `ui` | N/A |
100-
| `run-rustfix` | Apply all suggestions via `rustfix`, snapshot fixed output, and check fixed output builds | `ui` | N/A |
101-
| `rustfix-only-machine-applicable` | `run-rustfix` but only machine-applicable suggestions | `ui` | N/A |
102-
| `exec-env` | Env var to set when executing a test | `ui`, `crashes` | `<KEY>=<VALUE>` |
103-
| `unset-exec-env` | Env var to unset when executing a test | `ui`, `crashes` | Any env var name |
104-
| `stderr-per-bitwidth` | Generate a stderr snapshot for each bitwidth | `ui` | N/A |
105-
| `forbid-output` | A pattern which must not appear in `cfail` output | `incremental` | Regex pattern |
106-
| `run-flags` | Flags passed to the test executable | `ui` | Arbitrary flags |
107-
| `known-bug` | No error annotation needed due to known bug | `ui`, `crashes`, `incremental` | Issue number `#123456` |
88+
| Directive | Explanation | Supported test suites | Possible values |
89+
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|-----------------------------------------------------------------------------------------|
90+
| `check-run-results` | Check run test binary `run-{pass,fail}` output snapshot | `ui`, `crashes`, `incremental` if `run-pass` | N/A |
91+
| `error-pattern` | Check that output contains a regex pattern | `ui`, `crashes`, `incremental` if `run-pass` | Regex |
92+
| `check-stdout` | Check `stdout` against `error-pattern`s from running test binary[^check_stdout] | `ui`, `crashes`, `incremental` | N/A |
93+
| `compare-output-lines-by-subset` | Check output contains the contents of the snapshot by lines opposed to checking for strict equality | `ui`, `coverage` | N/A |
94+
| `normalize-stderr-32bit` | Normalize actual stderr (for 32-bit platforms) with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental` | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
95+
| `normalize-stderr-64bit` | Normalize actual stderr (for 64-bit platforms) with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental` | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
96+
| `normalize-stderr-test` | Normalize actual stderr with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental` | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
97+
| `normalize-stdout-test` | Normalize actual stdout with a rule `"<raw>" -> "<normalized>"` before comparing against snapshot | `ui`, `incremental` | `"<RAW>" -> "<NORMALIZED>"`, `<RAW>`/`<NORMALIZED>` is regex capture and replace syntax |
98+
| `dont-check-compiler-stderr` | Don't check actual compiler stderr vs stderr snapshot | `ui` | N/A |
99+
| `dont-check-compiler-stdout` | Don't check actual compiler stdout vs stdout snapshot | `ui` | N/A |
100+
| `run-rustfix` | Apply all suggestions via `rustfix`, snapshot fixed output, and check fixed output builds | `ui` | N/A |
101+
| `rustfix-only-machine-applicable` | `run-rustfix` but only machine-applicable suggestions | `ui` | N/A |
102+
| `exec-env` | Env var to set when executing a test | `ui`, `crashes` | `<KEY>=<VALUE>` |
103+
| `unset-exec-env` | Env var to unset when executing a test | `ui`, `crashes` | Any env var name |
104+
| `stderr-per-bitwidth` | Generate a stderr snapshot for each bitwidth | `ui` | N/A |
105+
| `forbid-output` | A pattern which must not appear in `cfail` output | `incremental` | Regex pattern |
106+
| `run-flags` | Flags passed to the test executable | `ui` | Arbitrary flags |
107+
| `known-bug` | No error annotation needed due to known bug | `ui`, `crashes`, `incremental` | Issue number `#123456` |
108108

109109
[^check_stdout]: presently <!-- date-check: Oct 2024 --> this has a weird quirk
110110
where the test binary's stdout and stderr gets concatenated and then

0 commit comments

Comments
 (0)