]> git.lizzy.rs Git - rust.git/commitdiff
expand flag docs
authorRalf Jung <post@ralfj.de>
Wed, 28 Oct 2020 11:51:25 +0000 (12:51 +0100)
committerRalf Jung <post@ralfj.de>
Wed, 28 Oct 2020 12:03:46 +0000 (13:03 +0100)
README.md

index 0aa22a81ad5cb81f3ee29ca03cda06dca4416f43..0c280edec0ce6986f000783d7d2f93b87b1021ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -240,9 +240,12 @@ environment variable:
   future use of it will error).  This helps you in finding out why UB is
   happening and where in your code would be a good place to look for it.
 * `-Zmiri-track-raw-pointers` makes Stacked Borrows track a pointer tag even for
-  raw pointers. This can make valid code fail to pass the checks (when
-  integer-pointer casts are involved), but also can help identify latent
-  aliasing issues in code that Miri accepts by default.
+  raw pointers. This can make valid code fail to pass the checks, but also can
+  help identify latent aliasing issues in code that Miri accepts by default. You
+  can recognize false positives by "<untagged>" occurring in the message -- this
+  indicates a pointer that was cast from an integer, so Miri was unable to track
+  this pointer. Make sure to use a non-Windows target with this flag, as the
+  Windows runtime makes use of integer-pointer casts.
 
 Some native rustc `-Z` flags are also very relevant for Miri: