]> git.lizzy.rs Git - rust.git/commitdiff
readme: mention data races, and mention cross-interpretation already in the intro
authorRalf Jung <post@ralfj.de>
Sat, 5 Dec 2020 11:14:52 +0000 (12:14 +0100)
committerRalf Jung <post@ralfj.de>
Sat, 5 Dec 2020 11:14:52 +0000 (12:14 +0100)
README.md

index 02a64b3d5f7dc7b41fb4f0a61dbaa4db2f6845b1..3a8524ec01d34a228d700cbfbbe1b145d5f6b125 100644 (file)
--- 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!