From 866aeaecfc35cc54f03ab6bf777c39587dd4b042 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sat, 9 Feb 2019 12:44:56 +0100 Subject: [PATCH] explain arument passing in the docs --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 1d97b61f43d5..21e9fa43a8f8 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,13 @@ Now you can run your project in Miri: 3. If you have a binary project, you can run it through Miri using `cargo +nightly miri run`. +You can pass arguments to Miri after the first `--`, and pass arguments to the +interpreted program or test suite after the second `--`. For example, `cargo ++nightly miri run -- -Zmiri-disable-validation` runs the program without +validation of basic type invariants and references. `cargo +nightly miri test +-- -- filter` passes `filter` to the test suite the same way `cargo test filter` +would. + When running code via `cargo miri`, the `miri` config flag is set. You can use this to exclude test cases that will fail under Miri because they do things Miri does not support: