Skip to content

Commit 6671f83

Browse files
committed
Auto merge of rust-lang#2558 - RalfJung:tag-gc, r=saethlin
readme: tag-gc tweaks r? `@saethlin` Is this option truly needed often enough that it should be in the 'common' section? If not I vote for moving it to the 2nd section. Also `10,000` is a confusing way to write numbers in an international context (in many languages, `,` in a number plays the role of the point in English number notation, so using a space or underscore is less likely to lead to confusion).
2 parents 8e3b9bc + bef2bd8 commit 6671f83

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/tools/miri/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -324,10 +324,6 @@ environment variable. We first document the most relevant and most commonly used
324324
ensure alignment. (The standard library `align_to` method works fine in both modes; under
325325
symbolic alignment it only fills the middle slice when the allocation guarantees sufficient
326326
alignment.)
327-
* `-Zmiri-tag-gc=<blocks>` configures how often the pointer tag garbage collector runs. The default
328-
is to search for and remove unreachable tags once every `10,000` basic blocks. Setting this to
329-
`0` disables the garbage collector, which causes some programs to have explosive memory usage
330-
and/or super-linear runtime.
331327

332328
The remaining flags are for advanced use only, and more likely to change or be removed.
333329
Some of these are **unsound**, which means they can lead
@@ -378,6 +374,10 @@ to Miri failing to detect cases of undefined behavior in a program.
378374
* `-Zmiri-retag-fields` changes Stacked Borrows retagging to recurse into fields.
379375
This means that references in fields of structs/enums/tuples/arrays/... are retagged,
380376
and in particular, they are protected when passed as function arguments.
377+
* `-Zmiri-tag-gc=<blocks>` configures how often the pointer tag garbage collector runs. The default
378+
is to search for and remove unreachable tags once every `10000` basic blocks. Setting this to
379+
`0` disables the garbage collector, which causes some programs to have explosive memory usage
380+
and/or super-linear runtime.
381381
* `-Zmiri-track-alloc-id=<id1>,<id2>,...` shows a backtrace when the given allocations are
382382
being allocated or freed. This helps in debugging memory leaks and
383383
use after free bugs. Specifying this argument multiple times does not overwrite the previous

0 commit comments

Comments
 (0)