diff options
| author | Ralf Jung <post@ralfj.de> | 2021-05-29 21:21:49 +0200 |
|---|---|---|
| committer | Oli Scherer <github35764891676564198441@oli-obk.de> | 2021-05-30 02:18:51 +0200 |
| commit | 07b4513dd658b3d4ab653fd6c957a55c678bd42f (patch) | |
| tree | b48131085d2c53eaffa10784b10acf4c852f0227 /src/doc/rustc-dev-guide | |
| parent | 13b8e1449f74d465a9f81896938fcf4f8f9532b9 (diff) | |
| download | rust-07b4513dd658b3d4ab653fd6c957a55c678bd42f.tar.gz rust-07b4513dd658b3d4ab653fd6c957a55c678bd42f.zip | |
explain Miri engine vs Miri-the-tool
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/miri.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/miri.md b/src/doc/rustc-dev-guide/src/miri.md index fd091d565b6..18cd6ed3923 100644 --- a/src/doc/rustc-dev-guide/src/miri.md +++ b/src/doc/rustc-dev-guide/src/miri.md @@ -2,8 +2,13 @@ <!-- toc --> -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: |