Skip to content

Commit 9ce9dae

Browse files
committed
update readme
1 parent c983ced commit 9ce9dae

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/tools/miri/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,9 @@ environment variable. We first document the most relevant and most commonly used
293293
value of forwarded variables stays the same. Has no effect if `-Zmiri-disable-isolation` is set.
294294
* `-Zmiri-ignore-leaks` disables the memory leak checker, and also allows some
295295
remaining threads to exist when the main thread exits.
296+
* `-Zmiri-num-cpus` states the number of available CPUs to be reported by miri. By default, the
297+
number of available CPUs is `1`. Note that this flag does not affect how miri handles threads in
298+
any way.
296299
* `-Zmiri-permissive-provenance` disables the warning for integer-to-pointer casts and
297300
[`ptr::from_exposed_addr`](https://doc.rust-lang.org/nightly/std/ptr/fn.from_exposed_addr.html).
298301
This will necessarily miss some bugs as those operations are not efficiently and accurately
@@ -357,7 +360,7 @@ to Miri failing to detect cases of undefined behavior in a program.
357360
This is **work in progress**; currently, only integer arguments and return values are
358361
supported (and no, pointer/integer casts to work around this limitation will not work;
359362
they will fail horribly). It also only works on unix hosts for now.
360-
Follow [the discussion on supporting other types](https://github.com/rust-lang/miri/issues/2365).
363+
Follow [the discussion on supporting other types](https://github.com/rust-lang/miri/issues/2365).
361364
* `-Zmiri-measureme=<name>` enables `measureme` profiling for the interpreted program.
362365
This can be used to find which parts of your program are executing slowly under Miri.
363366
The profile is written out to a file with the prefix `<name>`, and can be processed
@@ -387,7 +390,7 @@ to Miri failing to detect cases of undefined behavior in a program.
387390
Borrows "protectors". Specifying this argument multiple times does not overwrite the previous
388391
values, instead it appends its values to the list. Listing an id multiple times has no effect.
389392
* `-Zmiri-track-pointer-tag=<tag1>,<tag2>,...` shows a backtrace when a given pointer tag
390-
is created and when (if ever) it is popped from a borrow stack (which is where the tag becomes invalid
393+
is created and when (if ever) it is popped from a borrow stack (which is where the tag becomes invalid
391394
and any future use of it will error). This helps you in finding out why UB is
392395
happening and where in your code would be a good place to look for it.
393396
Specifying this argument multiple times does not overwrite the previous

0 commit comments

Comments
 (0)