From f4e82623b27c4220e89b1b3131b7fed2c142efa8 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sat, 29 May 2021 21:21:49 +0200 Subject: [PATCH] explain Miri engine vs Miri-the-tool --- src/miri.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/miri.md b/src/miri.md index fd091d56..18cd6ed3 100644 --- a/src/miri.md +++ b/src/miri.md @@ -2,8 +2,13 @@ -Miri (**MIR** **I**nterpreter) is a virtual machine for executing MIR without +The Miri (**MIR** **I**nterpreter) engine is a virtual machine for executing MIR without compiling to machine code. It is usually invoked via `tcx.const_eval_*` functions. +In the following, we will refer to the Miri engine as just "Miri", but note that +there also is a stand-alone +[tool called "Miri"](https://github.com/rust-lang/miri/) that is based on the +engine (sometimes referred to as Miri-the-tool to disambiguate it from the +engine). If you start out with a constant: