aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <egil@erlang.org>2016-02-25 15:13:32 +0100
committerBjörn-Egil Dahlberg <egil@erlang.org>2016-02-25 15:26:28 +0100
commit0ca09ee90d6384e74d1b18ab0e05f2c05fc03905 (patch)
treecee20d57c9b84f1720e36b75fc93c949906e85df /lib/kernel/doc/src
parentbedde8c59e568b15bee4b36dc4e4eaa93d00f63a (diff)
downloadotp-0ca09ee90d6384e74d1b18ab0e05f2c05fc03905.tar.gz
otp-0ca09ee90d6384e74d1b18ab0e05f2c05fc03905.tar.bz2
otp-0ca09ee90d6384e74d1b18ab0e05f2c05fc03905.zip
kernel: Clarify heart option
Change scheduler responsiveness to 'check_schedulers'.
Diffstat (limited to 'lib/kernel/doc/src')
-rw-r--r--lib/kernel/doc/src/heart.xml13
1 files changed, 10 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml
index a4569b5fb8..9da4773f2d 100644
--- a/lib/kernel/doc/src/heart.xml
+++ b/lib/kernel/doc/src/heart.xml
@@ -118,6 +118,13 @@
<p>In the following descriptions, all function fails with reason
<c>badarg</c> if <c>heart</c> is not started.</p>
</description>
+
+ <datatypes>
+ <datatype>
+ <name name="heart_option"/>
+ </datatype>
+ </datatypes>
+
<funcs>
<func>
<name name="set_cmd" arity="1"/>
@@ -188,12 +195,12 @@
<desc>
<p> Valid options <c>set_options</c> are: </p>
<taglist>
- <tag><c>scheduler</c></tag>
+ <tag><c>check_schedulers</c></tag>
<item>
- <p>If enabled, a message will be sent to each scheduler to check its
+ <p>If enabled, a signal will be sent to each scheduler to check its
responsiveness. The system check occurs before any heartbeat sent
to the port program. If any scheduler is not responsive enough the
- heart program will not receive its heartpeat and terminate the node.
+ heart program will not receive its heartbeat and thus eventually terminate the node.
</p>
</item>
</taglist>