clarify that a (tracked) tag may never be popped

Co-authored-by: Ralf Jung <post@ralfj.de>
This commit is contained in:
DQ 2022-07-03 15:47:39 +02:00 committed by GitHub
parent 672d721544
commit 1b9e19a39b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -383,7 +383,7 @@ to Miri failing to detect cases of undefined behavior in a program.
Borrows "protectors". Specifying this argument multiple times does not overwrite the previous
values, instead it appends its values to the list. Listing an id multiple times has no effect.
* `-Zmiri-track-pointer-tag=<tag1>,<tag2>,...` shows a backtrace when a given pointer tag
is created or when it is popped from a borrow stack (which is where the tag becomes invalid
is created and when (if ever) it is popped from a borrow stack (which is where the tag becomes invalid
and any 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.
Specifying this argument multiple times does not overwrite the previous