@@ -451,35 +451,32 @@ Some native rustc `-Z` flags are also very relevant for Miri:
451
451
* `-Zmir-emit-retag` controls whether `Retag` statements are emitted. Miri
452
452
enables this per default because it is needed for [Stacked Borrows] and [Tree Borrows].
453
453
454
- Moreover, Miri recognizes some environment variables :
454
+ Moreover, Miri recognizes some environment variables (unless noted otherwise, these are supported
455
+ by all intended entry points, i.e. `cargo miri` and `./miri {test,run}`) :
455
456
456
457
* `MIRI_AUTO_OPS` indicates whether the automatic execution of rustfmt, clippy and toolchain setup
457
458
should be skipped. If it is set to `no`, they are skipped. This is used to allow automated IDE
458
459
actions to avoid the auto ops.
459
460
* `MIRI_LOG`, `MIRI_BACKTRACE` control logging and backtrace printing during
460
461
Miri executions, also [see "Testing the Miri driver" in `CONTRIBUTING.md`][testing-miri].
461
- * `MIRIFLAGS` (recognized by `cargo miri` and the test suite) defines extra
462
- flags to be passed to Miri.
463
- * `MIRI_LIB_SRC` defines the directory where Miri expects the sources of the
464
- standard library that it will build and use for interpretation. This directory
465
- must point to the `library` subdirectory of a `rust-lang/rust` repository
466
- checkout.
467
- * `MIRI_SYSROOT` (recognized by `cargo miri` and the test suite) indicates the sysroot to use. When
468
- using `cargo miri`, this skips the automatic setup -- only set this if you do not want to use the
469
- automatically created sysroot. When invoking `cargo miri setup`, this indicates where the sysroot
470
- will be put.
471
- * `MIRI_TEST_TARGET` (recognized by the test suite and the `./miri` script) indicates which target
462
+ * `MIRIFLAGS` defines extra flags to be passed to Miri.
463
+ * `MIRI_LIB_SRC` defines the directory where Miri expects the sources of the standard library that
464
+ it will build and use for interpretation. This directory must point to the `library` subdirectory
465
+ of a `rust-lang/rust` repository checkout.
466
+ * `MIRI_SYSROOT` indicates the sysroot to use. When using `cargo miri`, this skips the automatic
467
+ setup -- only set this if you do not want to use the automatically created sysroot. When invoking
468
+ ` cargo miri setup` , this indicates where the sysroot will be put.
469
+ * `MIRI_TEST_TARGET` (recognized by `./miri {test,run}`) indicates which target
472
470
architecture to test against. `miri` and `cargo miri` accept the `--target` flag for the same
473
471
purpose.
474
- * `MIRI_TEST_THREADS` (recognized by the test suite): set the number of threads to use for running tests.
475
- By default the number of cores is used.
476
- * `MIRI_NO_STD` (recognized by `cargo miri`) makes sure that the target's sysroot is built without
477
- libstd. This allows testing and running no_std programs.
478
- (Miri has a heuristic to detect no-std targets based on the target name; this environment variable
479
- is only needed when that heuristic fails.)
480
- * `RUSTC_BLESS` (recognized by the test suite and `cargo-miri-test/run-test.py`): overwrite all
472
+ * `MIRI_TEST_THREADS` (recognized by `./miri test`): set the number of threads to use for running tests.
473
+ By default, the number of cores is used.
474
+ * `MIRI_NO_STD` makes sure that the target's sysroot is built without libstd. This allows testing
475
+ and running no_std programs. (Miri has a heuristic to detect no-std targets based on the target
476
+ name; this environment variable is only needed when that heuristic fails.)
477
+ * `RUSTC_BLESS` (recognized by `./miri test` and `cargo-miri-test/run-test.py`): overwrite all
481
478
` stderr` and `stdout` files instead of checking whether the output matches.
482
- * `MIRI_SKIP_UI_CHECKS` (recognized by the test suite ): don't check whether the
479
+ * `MIRI_SKIP_UI_CHECKS` (recognized by `./miri test` ): don't check whether the
483
480
` stderr` or `stdout` files match the actual output.
484
481
485
482
The following environment variables are *internal* and must not be used by
0 commit comments