]> git.lizzy.rs Git - rust.git/commitdiff
note Miri's leak check abilities and that they are disabled on Windows
authorRalf Jung <post@ralfj.de>
Mon, 13 Apr 2020 09:30:02 +0000 (11:30 +0200)
committerRalf Jung <post@ralfj.de>
Mon, 13 Apr 2020 09:30:02 +0000 (11:30 +0200)
README.md

index 4968e66657121cd248bd938307f64f97a631b25e..c3c5bba2c6f9bef5ba3d6fdd57a7201ca1bb7358 100644 (file)
--- a/README.md
+++ b/README.md
@@ -17,12 +17,17 @@ for example:
 * **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing
   for reference types
 
+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. Note however that
+[leak checking is currently disabled on Windows targets](https://github.com/rust-lang/miri/issues/1302).
+
 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!
 
-Be aware that Miri will **not catch all cases of undefined behavior** in your
-program, and cannot run all programs:
+However, be aware that Miri will **not catch all cases of undefined behavior**
+in your program, and cannot run all programs:
 
 * There are still plenty of open questions around the basic invariants for some
   types and when these invariants even have to hold. Miri tries to avoid false