From d3ce3de68c6a4d9db362f4128e8e544516f9d315 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sun, 12 Mar 2023 22:23:09 +0100 Subject: [PATCH] tweak readme --- src/tools/miri/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/tools/miri/README.md b/src/tools/miri/README.md index 93e00cca117..f0b73d05873 100644 --- a/src/tools/miri/README.md +++ b/src/tools/miri/README.md @@ -235,9 +235,9 @@ inherent interpreter slowdown and a loss of parallelism. You can get your test suite's parallelism back by running `cargo miri nextest run -jN` (note that you will need [`cargo-nextest`](https://nexte.st) installed). This works because `cargo-nextest` collects a list of all tests then launches a -separate `cargo miri run` for each test. You will need to specify a `-j` or `--test-threads`, -by default `cargo miri nextest run` runs one test at a time. You can find the `cargo-nextest` -documentation for its Miri support here: https://nexte.st/book/miri.html +separate `cargo miri run` for each test. You will need to specify a `-j` or `--test-threads`; +by default `cargo miri nextest run` runs one test at a time. For more details, see the +[`cargo-nextest` Miri documentation](https://nexte.st/book/miri.html). Note: This one-test-per-process model means that `cargo miri test` is able to detect data races where two tests race on a shared resource, but `cargo miri nextest run` will not detect