Skip to content

Commit b1f0537

Browse files
committed
Auto merge of #1303 - RalfJung:readme, r=RalfJung
tweak README Cc @Firstyear I realized the README has an example of unsupported code, so I changed the error to match that example.
2 parents 5e7180b + 73210be commit b1f0537

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ miri run -- -Zmiri-disable-validation` runs the program without validation of
8787
basic type invariants and without checking the aliasing of references.
8888

8989
When compiling code via `cargo miri`, the `miri` config flag is set. You can
90-
use this to ignore test cases that will fail under Miri because they do things
91-
Miri does not support:
90+
use this to ignore test cases that fail under Miri because they do things Miri
91+
does not support:
9292

9393
```rust
9494
#[test]
@@ -100,12 +100,11 @@ fn does_not_work_on_miri() {
100100
}
101101
```
102102

103-
An exhaustive list of what `miri` does not support is not available, as this could be
104-
an unbounded set with FFI and more. However `miri` will explicitly tell you when it finds
105-
something unsupported with an error, containing a message such as:
103+
There is no way to list all the infinite things Miri cannot do, but the
104+
interpreter will explicitly tell you when it finds something unsupported:
106105

107106
```
108-
error: unsupported operation: can't call foreign function: mach_timebase_info
107+
error: unsupported operation: Miri does not support threading
109108
...
110109
= help: this is likely not a bug in the program; it indicates that the program \
111110
performed an operation that the interpreter does not support

0 commit comments

Comments
 (0)