Add a description of how FileCheck is used for mir-opt tests#2718
Open
meithecatte wants to merge 1 commit intorust-lang:mainfrom
Open
Add a description of how FileCheck is used for mir-opt tests#2718meithecatte wants to merge 1 commit intorust-lang:mainfrom
meithecatte wants to merge 1 commit intorust-lang:mainfrom
Conversation
Collaborator
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
rustbot
added
the
S-waiting-on-review
Author
|
r? rustc-dev-guide |
jyn514
approved these changes
Jan 5, 2026
Member
jyn514
left a comment
jyn514
left a comment
There was a problem hiding this comment.
this seems fine. do you mind also documenting //@ test-mir-pass?
i notice that the in-tree docs at tests/mir-opt say that the format for verifying the output of a pass is x.after.mir, but the dev-guide is inconsistent; sometimes it says x.mir and sometimes it says x.after.mir. do you mind changing it to x.after.mir everywhere for consistency?
i'm wondering now if it makes sense to just inline everything in the in-tree README into the guide and change it to just link here ...
Member
|
having those docs duplicated sounds bad, yeah |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This had me quite confused until I figured out that, as documented in the README of
tests/mir-opt, the FileCheck runs on the runtime MIR, rather than the output of theEMIT_MIRdirective. This PR documents this in the dev guide as well, to make this information easier to find.