From e449dccd3764b8adb1be4787b345eae9b0c7306e Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Sun, 16 Feb 2020 12:38:00 +0100 Subject: [PATCH] clarify caveats --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b5e54e64bc40..1f008e735ec2 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,13 @@ for example: * Not sufficiently aligned memory accesses and references * Violation of *some* basic type invariants (a `bool` that is not 0 or 1, for example, or an invalid enum discriminant) -* WIP: Violations of the rules governing aliasing for reference types +* **Experimental**: Violations of the rules governing aliasing for reference types 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 +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