Skip to content

Commit f761a1f

Browse files
committed
update readme for MIRI_LIB_SRC
1 parent 4ab3218 commit f761a1f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ To run the tests yourself, make sure you have Miri installed (`rustup component
1313

1414
This will run the test suite of the standard library of your current toolchain.
1515
`--all-targets` means that doc tests are skipped; those should use separate Miri flags as there are some (expected) memory leaks.
16-
If you are working on the standard library and want to check that the tests pass with your modifications, set `RUST_SRC` to the checkout you are working in:
16+
17+
If you are working on the standard library and want to check that the tests pass with your modifications, set `MIRI_LIB_SRC` to the `library` folder of the checkout you are working in:
1718

1819
```shell
19-
RUST_SRC=~/path/to/rustc ./run-test.sh core --all-targets
20+
MIRI_LIB_SRC=~/path/to/rustc/library ./run-test.sh core --all-targets
2021
```
2122

2223
Here, `~/path/to/rustc` should be the directory containing `x.py`.
2324
Then the test suite will be compiled from the standard library in that directory.
2425
Make sure that is as close to your rustup default toolchain as possible, as the toolchain will still be used to build that standard library and its test suite.
26+
If you are getting strange build errors, `cargo clean` can often fix that.
2527

2628
`run-test` also accepts parameters that are passed to `cargo test` and the test runner,
2729
and `MIRIFLAGS` can be used as usual to pass parameters to Miri:

0 commit comments

Comments
 (0)