From 45a4a46333b1e8e6f66ba923deaf947a67ae7737 Mon Sep 17 00:00:00 2001
From: Simon Cornish <7t9jna402@sneakemail.com>
Date: Mon, 25 Apr 2016 22:21:07 -0700
Subject: 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.
---
 lib/kernel/doc/src/heart.xml | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'lib/kernel/doc/src')

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>:
-- 
cgit v1.2.3