Skip to content

Commit 64eedc1

Browse files
committed
Auto merge of #2100 - RalfJung:readme, r=RalfJung
tweak MIRI_SYSROOT docs
2 parents d595c62 + 9bb4410 commit 64eedc1

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -361,9 +361,10 @@ Moreover, Miri recognizes some environment variables:
361361
checkout. Note that changing files in that directory does not automatically
362362
trigger a re-build of the standard library; you have to clear the Miri build
363363
cache manually (on Linux, `rm -rf ~/.cache/miri`).
364-
* `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite)
365-
indicates the sysroot to use. To do the same thing with `miri`
366-
directly, use the `--sysroot` flag.
364+
* `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite) indicates the
365+
sysroot to use. Only set this if you do not want to use the automatically
366+
created sysroot. (The `miri` driver sysroot is controlled via the `--sysroot`
367+
flag instead.)
367368
* `MIRI_TEST_TARGET` (recognized by the test suite) indicates which target
368369
architecture to test against. `miri` and `cargo miri` accept the `--target`
369370
flag for the same purpose.

0 commit comments

Comments
 (0)