Skip to content

Commit

Permalink
Auto merge of #1148 - yoshuawuyts:patch-1, r=RalfJung
Browse files Browse the repository at this point in the history
Document miri can only be installed on nightly

This updates the installation instructions to point out that miri is only available on nightly, and encodes this assumption into the installation instructions.

It took me a bit of research to find out *why* miri wasn't installing on `windows-msvc`:
```txt
C:\Users\yoshu> rustup component add miri
error: component 'miri' for target 'x86_64-pc-windows-msvc' is unavailable for download for channel stable
```

I thought it must 've been something with the `msvc` target, but it turned out I was running on `stable`, and miri can only be installed on `nightly`. Having that be clearer in the installation instructions would've saved me some time debugging. Thanks!
  • Loading branch information
bors committed Jan 28, 2020
2 parents 8340358 + 0acc309 commit b5603ed
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ program, and cannot run all programs:

## Using Miri

Install Miri via `rustup`:
Install Miri on Rust nightly via `rustup`:

```sh
rustup component add miri
rustup +nightly component add miri
```

If `rustup` says the `miri` component is unavailable, that's because not all
Expand Down

0 comments on commit b5603ed

Please sign in to comment.