Skip to content

Commit c96efcd

Browse files
committed
adjust README for rustc-dev
1 parent e842a93 commit c96efcd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@ Miri heavily relies on internal rustc interfaces to execute MIR. Still, some
3131
things (like adding support for a new intrinsic or a shim for an external
3232
function being called) can be done by working just on the Miri side.
3333

34-
To prepare, make sure you are using a nightly Rust compiler. Then you should be
35-
able to just `cargo build` Miri.
34+
To prepare, make sure you are using a nightly Rust compiler. You also need to
35+
have the `rust-src` and `rustc-dev` components installed, which you can add via
36+
`rustup component add rust-src rustc-dev`. Then you should be able to just
37+
`cargo build` Miri.
3638

3739
In case this fails, your nightly might be incompatible with Miri master. The
3840
`rust-version` file contains the commit hash of rustc that Miri is currently
@@ -41,7 +43,7 @@ to wait for the next nightly to get released. You can also use
4143
[`rustup-toolchain-install-master`](https://github.com/kennytm/rustup-toolchain-install-master)
4244
to install that exact version of rustc as a toolchain:
4345
```
44-
rustup-toolchain-install-master $(cat rust-version) -c rust-src
46+
rustup-toolchain-install-master $(cat rust-version) -c rust-src -c rustc-dev
4547
```
4648

4749
Another common problem is outdated dependencies: Miri does not come with a

0 commit comments

Comments
 (0)