Skip to content

don't refer to the compile-time interpreter as "Miri" #1471

New issue

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

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

Already on GitHub? # to your account

Merged
merged 1 commit into from
Sep 26, 2022

Conversation

RalfJung
Copy link
Member

This leads to a lot of confusion when people think the compile-time interpreter does the same things as Miri-the-tool. Also given that the folders in the compiler source are called interpret, not miri, I think it's better to just call this "the (compile-time) (MIR) interpreter", not "Miri".

r? @oli-obk

Copy link
Member

@JohnTitor JohnTitor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add miri.html to

[output.html.redirect]
"/compiletest.html" = "tests/compiletest.html"
"/diagnostics/sessiondiagnostic.html" = "diagnostics/diagnostic-structs.html"
not to break the old link?

src/interpret.md Outdated
@@ -1,14 +1,13 @@
# Miri
# Interpreter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could move this under src/mir, placing it on the top-level dir seems a bit ambiguous to me.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the TOC it is listed below const-eval so maybe we should make that a folder?

@JohnTitor JohnTitor merged commit 7743f0f into rust-lang:master Sep 26, 2022
@JohnTitor
Copy link
Member

Thanks!

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 3, 2023
…kh726

avoid 'miri' when refering to the shared interpreter

This is basically the rustc source code version of rust-lang/rustc-dev-guide#1471.
Kobzol pushed a commit to Kobzol/rustc-dev-guide that referenced this pull request Jan 3, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants