Skip to content

Commit acb43f8

Browse files
committed
Document the new flag
1 parent eab2538 commit acb43f8

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Several `-Z` flags are relevant for Miri:
160160
the program has access to host resources such as environment variables and
161161
randomness (and, eventually, file systems and more).
162162
* `-Zmiri-ignore-leaks` disables the memory leak checker.
163-
* `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from
163+
* `-Zmiri-env-exclude=<var>` keeps the `var` environment variable isolated from
164164
the host. Can be used multiple times to exclude several variables. The `TERM`
165165
environment variable is excluded by default.
166166
* `-Zmir-opt-level` controls how many MIR optimizations are performed. Miri
@@ -171,6 +171,11 @@ Several `-Z` flags are relevant for Miri:
171171
sets this flag per default.
172172
* `-Zmir-emit-retag` controls whether `Retag` statements are emitted. Miri
173173
enables this per default because it is needed for validation.
174+
* `-Zmiri-track-pointer-tag` aborts interpretation with a backtrace when the
175+
given pointer tag is popped from a borrow stack (which is where the tag
176+
becomes invalid and any future use of it will error anyway). This helps you
177+
in finding out why UB is happening and where in your code would be a good
178+
place to look for it.
174179

175180
Moreover, Miri recognizes some environment variables:
176181

0 commit comments

Comments
 (0)