summaryrefslogtreecommitdiff
path: root/lib/tools/doc/src/instrument.xml
diff options
context:
space:
mode:
authorJohn Högberg <john@erlang.org>2018-05-03 12:37:49 +0200
committerJohn Högberg <john@erlang.org>2018-06-28 09:05:43 +0200
commitc7dc896e8897988ccc033e18fa19670ba7160565 (patch)
treec0aa20a10c35fb0b5a93d23d9813bab3cc6f4514 /lib/tools/doc/src/instrument.xml
parentd3147dd8fc0ee913bc7146efb4d041d04f6582d8 (diff)
downloaderlang-c7dc896e8897988ccc033e18fa19670ba7160565.tar.gz
Allow cross-type carrier migration
Diffstat (limited to 'lib/tools/doc/src/instrument.xml')
-rw-r--r--lib/tools/doc/src/instrument.xml13
1 files changed, 8 insertions, 5 deletions
diff --git a/lib/tools/doc/src/instrument.xml b/lib/tools/doc/src/instrument.xml
index 9fd9332373..79bacb2927 100644
--- a/lib/tools/doc/src/instrument.xml
+++ b/lib/tools/doc/src/instrument.xml
@@ -111,15 +111,18 @@
default, but this can be configured an a per-allocator basis with the
<seealso marker="erts:erts_alloc#M_atags"><c>+M&lt;S&gt;atags</c>
</seealso> emulator option.</p>
- <p>If tagged allocations are not enabled on any of the specified
- allocator types, the call will fail with
- <c>{error, not_enabled}</c>.</p>
+ <p>If the specified allocator types are not enabled, the call will fail
+ with <c>{error, not_enabled}</c>.</p>
<p>The following options can be used:</p>
<taglist>
<tag><c>allocator_types</c></tag>
<item>
- <p>The allocator types that will be searched. Defaults to all
- <c>alloc_util</c> allocators.</p>
+ <p>The allocator types that will be searched. Note that blocks can
+ move freely between allocator types, so restricting the search to
+ certain allocators may return unexpected types (e.g. process
+ heaps when searching binary_alloc), or hide blocks that were
+ migrated out.</p>
+ <p>Defaults to all <c>alloc_util</c> allocators.</p>
</item>
<tag><c>scheduler_ids</c></tag>
<item>