Skip to content

Commit 5382f46

Browse files
committed
Auto merge of rust-lang#2316 - domenicquirl:readme-track-tag, r=RalfJung
Clarify the effect of the `-Zmiri-track-pointer-tag` flag in the README Edit the README to explicitly say that the `-Zmiri-track-pointer-tag` flag also tracks the creation of tags, not just when they are popped/invalidated. Related to rust-lang/miri#2308 / Manishearth/triomphe#38.
2 parents e86cd1a + 1b9e19a commit 5382f46

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,8 +383,8 @@ to Miri failing to detect cases of undefined behavior in a program.
383383
Borrows "protectors". Specifying this argument multiple times does not overwrite the previous
384384
values, instead it appends its values to the list. Listing an id multiple times has no effect.
385385
* `-Zmiri-track-pointer-tag=<tag1>,<tag2>,...` shows a backtrace when a given pointer tag
386-
is popped from a borrow stack (which is where the tag becomes invalid and any
387-
future use of it will error). This helps you in finding out why UB is
386+
is created and when (if ever) it is popped from a borrow stack (which is where the tag becomes invalid
387+
and any future use of it will error). This helps you in finding out why UB is
388388
happening and where in your code would be a good place to look for it.
389389
Specifying this argument multiple times does not overwrite the previous
390390
values, instead it appends its values to the list. Listing a tag multiple times has no effect.

0 commit comments

Comments
 (0)