Skip to content

Commit df0e32c

Browse files
committed
Auto merge of #1329 - RalfJung:readme, r=RalfJung
note Miri's leak check abilities and that they are disabled on Windows
2 parents fbbd442 + a6b66c3 commit df0e32c

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,17 @@ for example:
1717
* **Experimental**: Violations of the [Stacked Borrows] rules governing aliasing
1818
for reference types
1919

20+
On top of that, Miri will also tell you about memory leaks: when there is memory
21+
still allocated at the end of the execution, and that memory is not reachable
22+
from a global `static`, Miri will raise an error. Note however that
23+
[leak checking is currently disabled on Windows targets](https://github.com/rust-lang/miri/issues/1302).
24+
2025
Miri has already discovered some [real-world bugs](#bugs-found-by-miri). If you
2126
found a bug with Miri, we'd appreciate if you tell us and we'll add it to the
2227
list!
2328

24-
Be aware that Miri will **not catch all cases of undefined behavior** in your
25-
program, and cannot run all programs:
29+
However, be aware that Miri will **not catch all cases of undefined behavior**
30+
in your program, and cannot run all programs:
2631

2732
* There are still plenty of open questions around the basic invariants for some
2833
types and when these invariants even have to hold. Miri tries to avoid false

0 commit comments

Comments
 (0)