File tree Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Expand file tree Collapse file tree 1 file changed +11
-0
lines changed Original file line number Diff line number Diff line change @@ -22,6 +22,16 @@ some of the functionality we rely on is privileged. Test artifacts are
22
22
transparently created as long as the ` generate-unit-test-files ` feature is
23
23
active, which is enabled by default for testing.
24
24
25
+ ### Running Miri
26
+ [ Miri] [ miri ] is used for testing the crate for any undefined behavior.
27
+ The interpreter is restricted to functionality that does not cross FFI
28
+ boundaries and won't perform I/O. To run all eligible tests, use:
29
+ ``` sh
30
+ # Miri usage conflicts with custom test runners, so don't over write it.
31
+ $ rm .cargo/config.toml
32
+ $ MIRIFLAGS=' -Zmiri-disable-stacked-borrows' cargo miri test --workspace -- " :miri:"
33
+ ```
34
+
25
35
26
36
## Benchmarking
27
37
We use a mixture of [ Criterion] [ criterion ] end-to-end benchmarks and [ ` libtest `
@@ -88,3 +98,4 @@ $ RUST_LIB_BACKTRACE=1 cargo test --test=allocs -- normalize_process --nocapture
88
98
[ criterion ] : https://crates.io/crates/criterion
89
99
[ flamegraph ] : https://crates.io/crates/flamegraph
90
100
[ libtest ] : https://doc.rust-lang.org/1.4.0/book/benchmark-tests.html
101
+ [ miri ] : https://github.com/rust-lang/miri
You can’t perform that action at this time.
0 commit comments