From 7fb012fdb2608c51f2eba7f2ec00525b4d3cd6ad Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sat, 5 Dec 2020 12:14:52 +0100 Subject: [PATCH] readme: mention data races, and mention cross-interpretation already in the intro --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 02a64b3d5f7..3a8524ec01d 100644 --- a/README.md +++ b/README.md @@ -20,11 +20,18 @@ for example: or an invalid enum discriminant) * **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing for reference types +* **Experimental**: Data races (but no weak memory effects) On top of that, Miri will also tell you about memory leaks: when there is memory still allocated at the end of the execution, and that memory is not reachable from a global `static`, Miri will raise an error. +You can use Miri to emulate programs on other targets, e.g. to ensure that +byte-level data manipulation works correctly both on little-endian and +big-endian systems. See +[cross-interpretation](#cross-interpretation-running-for-different-targets) +below. + Miri has already discovered some [real-world bugs](#bugs-found-by-miri). If you found a bug with Miri, we'd appreciate if you tell us and we'll add it to the list!