Skip to content

Commit 67e1235

Browse files
authored
README: Suggest using a previous nightly, revert other approach
1 parent d5cdba5 commit 67e1235

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ Install Miri via `rustup`:
5353
rustup component add miri
5454
```
5555

56+
### error: component 'miri' is unavailable for download (nightly)
57+
58+
The development of rustc's internals is quite fast paced. Downstream projects that rely on nightly internals, particularly clippy, can break fairly often because of this.
59+
60+
When such breakages occur the nightly release will be missing Miri. This is a trade-off compared with the other option of just not publishing the night's release, but does avoid blocking the rust nightly releases for people that don't need clippy/Miri.
61+
62+
To mitigate the issues we have:
63+
* rustup will warn if the update is missing any components you currently have. This means you can no longer accidentally update to a no-Miri release. Once Miri is available again it'll update.
64+
* However, if you need latest nightly Miri you can use <https://rust-lang.github.io/rustup-components-history/> to find and install a dated nightly release e.g. `rustup install nightly-2018-12-06`.
65+
5666
Now you can run your project in Miri:
5767

5868
1. Run `cargo clean` to eliminate any cached dependencies. Miri needs your
@@ -88,19 +98,9 @@ fn does_not_work_on_miri() {
8898

8999
### Common Problems
90100

91-
When using the above instructions, you may encounter a number of confusing
101+
When using the above instructions, you may encounter a number of confusing compiler
92102
errors.
93103

94-
#### "component 'miri' for target '\<target\>' is unavailable for download for channel 'nightly'"
95-
96-
The latest nightly may have broken Miri. If [this is the case][rust-toolstate], instead try to install Miri the old way with
97-
98-
```sh
99-
cargo +nightly install --force --git https://github.com/rust-lang/miri miri
100-
```
101-
102-
[rust-toolstate]:
103-
104104
#### "found possibly newer version of crate `std` which `<dependency>` depends on"
105105

106106
Your build directory may contain artifacts from an earlier build that have/have

0 commit comments

Comments
 (0)