Skip to content

Commit 263be25

Browse files
author
Johnathan Van Why
committed
Improvements to the README item on -Zmiri-track-raw-pointers.
1. The double quotes around <untagged> are changed to backspaces, so <untagged> will render correctly in markdown. 2. Clarify that -Zmiri-track-raw-pointers will never accept code that Miri would not have accepted without -Zmiri-track-raw-pointers.
1 parent 12dac5c commit 263be25

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,10 @@ environment variable:
252252
* `-Zmiri-track-raw-pointers` makes Stacked Borrows track a pointer tag even for
253253
raw pointers. This can make valid code fail to pass the checks, but also can
254254
help identify latent aliasing issues in code that Miri accepts by default. You
255-
can recognize false positives by "<untagged>" occurring in the message -- this
255+
can recognize false positives by `<untagged>` occurring in the message -- this
256256
indicates a pointer that was cast from an integer, so Miri was unable to track
257-
this pointer.
257+
this pointer. It does not have false negatives; code that works with
258+
`-Zmiri-track-raw-pointers` will work without `-Zmiri-track-raw-pointers`.
258259

259260
Some native rustc `-Z` flags are also very relevant for Miri:
260261

0 commit comments

Comments
 (0)