summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRickard Green <rickard@erlang.org>2021-09-07 21:05:05 +0200
committerRickard Green <rickard@erlang.org>2021-09-07 21:05:05 +0200
commitcdd20dc8ea95313f09c6f84367e43a775439db8d (patch)
treee96db2e343179cf52f7fc0a22d0414e9e0fcb8b1
parente927a822511147dedb6551a44f3616a0dcdd4e37 (diff)
downloaderlang-cdd20dc8ea95313f09c6f84367e43a775439db8d.tar.gz
Adjust documentation of the net_ticker_spawn_options kernel parameter
-rw-r--r--lib/kernel/doc/src/kernel_app.xml17
1 files changed, 12 insertions, 5 deletions
diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml
index 5a9539e6ef..e659d50ffc 100644
--- a/lib/kernel/doc/src/kernel_app.xml
+++ b/lib/kernel/doc/src/kernel_app.xml
@@ -296,11 +296,18 @@
<tag><c>{net_ticker_spawn_options, Opts}</c></tag>
<item>
<marker id="net_ticker_spawn_options"></marker>
- <p>Defines a list of extra spawn options for dist_util:con_loop processes.
- When there is a large number of dist connections, setting up garbage collection
- options can be helpful to reduce memory usage. Default is [link, {priority, max}],
- and these two options cannot be changed.
- See <seemfa marker="erts:erlang#spawn_opt/2"><c>erlang:spawn_opt/2</c></seemfa>.</p>
+ <p>
+ Defines a list of extra spawn options for net ticker processes. There exist
+ one such process for each connection to another node. A net ticker process is
+ responsible for supervising the connection it is associated with. These
+ processes also execute the distribution handshake protocol when setting up
+ connections. When there is a large number of distribution connections,
+ setting up garbage collection options can be helpful to reduce memory usage.
+ Default is <c>[link, {priority, max}]</c>, and these two options cannot be
+ changed. See the documentation of the
+ <seemfa marker="erts:erlang#spawn_opt/4"><c>erlang:spawn_opt/4</c></seemfa>
+ BIF for information about valid options.
+ </p>
</item>
<tag><c>inet_parse_error_log = silent</c></tag>
<item>