mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Auto merge of #1293 - Firstyear:1289-miri-readme, r=RalfJung

Browse Source 
Update readme to make supported code clearer

Fixes https://github.com/rust-lang/miri/issues/1289

This makes it clearer in the readme how miri will warn of supported or unsupported code in a program under test/run.

Thanks!
This commit is contained in:
bors 2020-04-04 16:27:16 +00:00
commit 5e7180bf46
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -100,6 +100,17 @@ fn does_not_work_on_miri() {
}
```
An exhaustive list of what `miri` does not support is not available, as this could be
an unbounded set with FFI and more. However `miri` will explicitly tell you when it finds
something unsupported with an error, containing a message such as:
```
error: unsupported operation: can't call foreign function: mach_timebase_info
...
= help: this is likely not a bug in the program; it indicates that the program \
performed an operation that the interpreter does not support
```
### Running Miri on CI
To run Miri on CI, make sure that you handle the case where the latest nightly