aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/heart.xml
diff options
context:
space:
mode:
authorSimon Cornish <[email protected]>2016-04-25 22:21:07 -0700
committerSimon Cornish <[email protected]>2016-06-01 14:56:24 +0200
commit45a4a46333b1e8e6f66ba923deaf947a67ae7737 (patch)
treefeacad1dc2e8ca4e675aba503eafd20831491ce8 /lib/kernel/doc/src/heart.xml
parent523e048754f5086a6cc4fd9a250e1b495fc5b9b8 (diff)
downloadotp-45a4a46333b1e8e6f66ba923deaf947a67ae7737.tar.gz
otp-45a4a46333b1e8e6f66ba923deaf947a67ae7737.tar.bz2
otp-45a4a46333b1e8e6f66ba923deaf947a67ae7737.zip
Don't kill old erlang if HEART_NO_KILL is set
If the environment variable HEART_NO_KILL is set then heart won't kill the old erlang process. This is desirable if the command executed by heart takes care of this.
Diffstat (limited to 'lib/kernel/doc/src/heart.xml')
-rw-r--r--lib/kernel/doc/src/heart.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml
index 9da4773f2d..bfb4ce45e6 100644
--- a/lib/kernel/doc/src/heart.xml
+++ b/lib/kernel/doc/src/heart.xml
@@ -89,6 +89,16 @@
<pre>
% <input>erl -heart -env HEART_KILL_SIGNAL SIGABRT ...</input></pre>
+ <p> If heart should <b>not</b> kill the Erlang runtime system, this can be indicated
+ using the environment variable <c><![CDATA[HEART_NO_KILL]]></c>.
+ This can be useful if the command executed by heart takes care of this,
+ for example as part of a specific cleanup sequence.
+ If unset, the default behaviour will be to kill as described above.
+ </p>
+
+ <pre>
+% <input>erl -heart -env HEART_NO_KILL 1 ...</input></pre>
+
<p>
Furthermore, <c><![CDATA[ERL_CRASH_DUMP_SECONDS]]></c> has the following behaviour on
<c>heart</c>: