Skip to content

Commit 70af7ae

Browse files
committed
expand flag docs
1 parent 19e78a6 commit 70af7ae

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -240,9 +240,12 @@ environment variable:
240240
future use of it will error). This helps you in finding out why UB is
241241
happening and where in your code would be a good place to look for it.
242242
* `-Zmiri-track-raw-pointers` makes Stacked Borrows track a pointer tag even for
243-
raw pointers. This can make valid code fail to pass the checks (when
244-
integer-pointer casts are involved), but also can help identify latent
245-
aliasing issues in code that Miri accepts by default.
243+
raw pointers. This can make valid code fail to pass the checks, but also can
244+
help identify latent aliasing issues in code that Miri accepts by default. You
245+
can recognize false positives by "<untagged>" occurring in the message -- this
246+
indicates a pointer that was cast from an integer, so Miri was unable to track
247+
this pointer. Make sure to use a non-Windows target with this flag, as the
248+
Windows runtime makes use of integer-pointer casts.
246249

247250
Some native rustc `-Z` flags are also very relevant for Miri:
248251

0 commit comments

Comments
 (0)