Skip to content

Commit 91aeb04

Browse files
committed
Auto merge of #1748 - jrvanwhy:track-raw-pointers-doc, r=RalfJung
Improvements to the README item on `-Zmiri-track-raw-pointers`. [Rendered](https://github.com/jrvanwhy/miri/tree/track-raw-pointers-doc) Minor change: I changed the quotes around `<untagged>` into backticks, so they render correctly in markdown. ~~Significant change: I documented that `-Zmiri-track-raw-pointers` is a strictly more restrictive model that "normal" Stacked Borrows. **I am not confident this change is correct, please verify it.** If this change is not correct, let me know, and I'll update this PR to document that :-)~~ EDIT: I was wrong, `-Zmiri-track-raw-pointers` may not be strictly more restrictive. I added the following sentence to prevent others from making the same assumption that I did: > Note that it is not currently guaranteed that code that works with `-Zmiri-track-raw-pointers` also works without `-Zmiri-track-raw-pointers`.
2 parents b3f81fc + 1200561 commit 91aeb04

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,11 @@ 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. Note that it is not currently guaranteed that code that works
258+
with `-Zmiri-track-raw-pointers` also works without
259+
`-Zmiri-track-raw-pointers`, but for the vast majority of code, this will be the case.
258260

259261
Some native rustc `-Z` flags are also very relevant for Miri:
260262

0 commit comments

Comments
 (0)