From a6b66c31d7587254c71e60fa171827b3277f4a46 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Mon, 13 Apr 2020 11:30:02 +0200 Subject: [PATCH] note Miri's leak check abilities and that they are disabled on Windows --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4968e6665712..c3c5bba2c6f9 100644 --- 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