Skip to content

Add a description of how FileCheck is used for mir-opt tests #2718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
meithecatte wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

Add a description of how FileCheck is used for mir-opt tests #2718

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/tests/compiletest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,17 @@ problematic in the presence of pointers in constants or other bit width
dependent things. In that case you can add `// EMIT_MIR_FOR_EACH_BIT_WIDTH` to
your test, causing separate files to be generated for 32bit and 64bit systems.

On top of the snapshot-based checks performed on the output requested by `EMIT_MIR`,
the *final runtime MIR*, as emitted by `--emit=mir`, is checked with the LLVM
[FileCheck] tool. For this purpose, your test should be annotated with
`// CHECK` comments to verify the final emitted MIR is properly optimized.

See the [FileCheck] documentation for a tutorial and more information.

Note however, that in some cases, it can also make more sense to skip the FileCheck
step. To do this, add a `// skip-filecheck` annotation instead of the `// CHECK`
comments.

[`tests/mir-opt`]: https://github.com/rust-lang/rust/tree/HEAD/tests/mir-opt


Expand Down
Loading