diff options
| author | bors <bors@rust-lang.org> | 2024-02-04 21:16:02 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2024-02-04 21:16:02 +0000 |
| commit | f45a5b10a071f9f5b259a6502ed9b39243d1d7b5 (patch) | |
| tree | 0455d5f02c1dbdbd8091dea4a0cb80572d0ff8d1 | |
| parent | 0602b1350be75e6f3c035666e4dbe0fa078cd3e7 (diff) | |
| parent | 5587a37384f3fc0e266196f4b009d442a7e0552d (diff) | |
| download | rust-f45a5b10a071f9f5b259a6502ed9b39243d1d7b5.tar.gz rust-f45a5b10a071f9f5b259a6502ed9b39243d1d7b5.zip | |
Auto merge of #3290 - tv42:master, r=saethlin
Stop recommending cargo clean in README
Miri has used the `target/miri` subdirectory since 2021 to keep itself separate from non-miri builds, so this should not be necessary.
See commit 6a18683d09f74ead9438aa7fdd323b18821f7709
Since the items are no longer a sequence of steps to do in order ("first, make sure that ..."), switch to an unordered list while we're at it.
Closes #3289
| -rw-r--r-- | src/tools/miri/README.md | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md index 6695f123c78..60bf07b1736 100644 --- a/src/tools/miri/README.md +++ b/src/tools/miri/README.md @@ -108,11 +108,8 @@ assume the right toolchain is pinned via `rustup override set nightly` or Now you can run your project in Miri: -1. Run `cargo clean` to eliminate any cached dependencies. Miri needs your - dependencies to be compiled the right way, that would not happen if they have - previously already been compiled. -2. To run all tests in your project through Miri, use `cargo miri test`. -3. If you have a binary project, you can run it through Miri using `cargo miri run`. +- To run all tests in your project through Miri, use `cargo miri test`. +- If you have a binary project, you can run it through Miri using `cargo miri run`. The first time you run Miri, it will perform some extra setup and install some dependencies. It will ask you for confirmation before installing anything. |