From 620bf348e1d793e2b1e13ea0b4af52f883d911ae Mon Sep 17 00:00:00 2001 From: Ross Smyth <18294397+RossSmyth@users.noreply.github.com> Date: Wed, 8 May 2024 16:37:48 -0400 Subject: [PATCH] Update documentation for miri-script test changes --- src/tools/miri/CONTRIBUTING.md | 9 ++++----- src/tools/miri/README.md | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/tools/miri/CONTRIBUTING.md b/src/tools/miri/CONTRIBUTING.md index 60bc1d5282d..39aed51f5df 100644 --- a/src/tools/miri/CONTRIBUTING.md +++ b/src/tools/miri/CONTRIBUTING.md @@ -72,14 +72,13 @@ For example: You can (cross-)run the entire test suite using: -``` -./miri test -MIRI_TEST_TARGET=i686-unknown-linux-gnu ./miri test +```sh +./miri test --target i686-unknown-linux-gnu ``` `./miri test FILTER` only runs those tests that contain `FILTER` in their filename (including the -base directory, e.g. `./miri test fail` will run all compile-fail tests). These filters are passed -to `cargo test`, so for multiple filters you need to use `./miri test -- FILTER1 FILTER2`. +base directory, e.g. `./miri test fail` will run all compile-fail tests). Multiple filters +are supported: `./miri test FILTER1 FILTER2`. #### Fine grained logging diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md index 2c76749fbca..6e0c96499e2 100644 --- a/src/tools/miri/README.md +++ b/src/tools/miri/README.md @@ -464,7 +464,7 @@ by all intended entry points, i.e. `cargo miri` and `./miri {test,run}`): setup -- only set this if you do not want to use the automatically created sysroot. When invoking `cargo miri setup`, this indicates where the sysroot will be put. * `MIRI_TEST_TARGET` (recognized by `./miri {test,run}`) indicates which target - architecture to test against. `miri` and `cargo miri` accept the `--target` flag for the same + architecture to test against. The `--target` flag may be used for the same purpose. * `MIRI_TEST_THREADS` (recognized by `./miri test`): set the number of threads to use for running tests. By default, the number of cores is used.