aboutsummaryrefslogtreecommitdiffstats
path: root/erts
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2017-11-20 10:52:30 +0100
committerLukas Larsson <[email protected]>2017-11-20 10:52:30 +0100
commitf91898fc08c28195dd2e9cbfb15bfd91a5584550 (patch)
tree8a500e9a3f7e1a53e55b9cbc3cd4c053d187631c /erts
parent3b5fced77873fa6ee87a81a6162acf9d9f43c6de (diff)
parentc4606d0ce55eac7c383520de765cffba2c235ace (diff)
downloadotp-f91898fc08c28195dd2e9cbfb15bfd91a5584550.tar.gz
otp-f91898fc08c28195dd2e9cbfb15bfd91a5584550.tar.bz2
otp-f91898fc08c28195dd2e9cbfb15bfd91a5584550.zip
Merge branch 'lukas/system/improve_profile_docs/OTP-14633' into maint
* lukas/system/improve_profile_docs/OTP-14633: erts: Add term2bin note about encoding guarantee Fix broken link in INSTALL howto system: Add info to profiling effeciency guide Update message queue and pinfo binary docs kernel: Clarify gen_tcp:listen documentation system: Add External OSS tools section to profiling guilde
Diffstat (limited to 'erts')
-rw-r--r--erts/doc/src/erlang.xml19
1 files changed, 15 insertions, 4 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 2465f49581..b04f2b008e 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -2955,7 +2955,10 @@ os_prompt%</pre>
<p>The total amount of memory currently allocated for
the emulator that is not directly related to any Erlang
process. Memory presented as <c>processes</c> is not
- included in this memory.</p>
+ included in this memory. <seealso marker="tools:instrument">
+ <c>instrument(3)</c></seealso> can be used to
+ get a more detailed breakdown of what memory is part
+ of this type.</p>
</item>
<tag><c>atom</c></tag>
<item>
@@ -4687,7 +4690,7 @@ RealSystem = system + MissedSystem</code>
<p>The default <c>message_queue_data</c> process flag is determined
by command-line argument <seealso marker="erl#+hmqd">
<c>+hmqd</c></seealso> in <c>erl(1)</c>.</p>
- <p>If the process potentially can get many messages,
+ <p>If the process potentially can get many messages in its queue,
you are advised to set the flag to <c>off_heap</c>. This
because a garbage collection with many messages placed on
the heap can become extremely expensive and the process can
@@ -4960,11 +4963,15 @@ RealSystem = system + MissedSystem</code>
<tag><c>{binary, <anno>BinInfo</anno>}</c></tag>
<item>
<p><c><anno>BinInfo</anno></c> is a list containing miscellaneous
- information about binaries currently referred to by this
- process. This <c><anno>InfoTuple</anno></c> can be changed or
+ information about binaries on the heap of this
+ process.
+ This <c><anno>InfoTuple</anno></c> can be changed or
removed without prior notice. In the current implementation
<c><anno>BinInfo</anno></c> is a list of tuples. The tuples
contain; <c>BinaryId</c>, <c>BinarySize</c>, <c>BinaryRefcCount</c>.</p>
+ <p>The message queue is on the heap depending on the
+ process flag <seealso marker="#process_flag_message_queue_data">
+ <c>message_queue_data</c></seealso>.</p>
</item>
<tag><c>{catchlevel, <anno>CatchLevel</anno>}</c></tag>
<item>
@@ -8869,6 +8876,10 @@ hello
</pre>
<p>See also <seealso marker="#binary_to_term/1">
<c>binary_to_term/1</c></seealso>.</p>
+ <note>
+ <p>There is no guarantee that this function will return
+ the same encoded representation for the same term.</p>
+ </note>
</desc>
</func>