From 281fb9929e2cdcfdaf95e0b90b3b690b78535ddb Mon Sep 17 00:00:00 2001
From: Siri Hansen <siri@erlang.org>
Date: Mon, 24 Oct 2011 14:25:15 +0200
Subject: Document upgrade instructions restart_new_emulator and
 restart_emulator

---
 system/doc/design_principles/appup_cookbook.xml | 43 +++++++++++++++++--------
 1 file changed, 30 insertions(+), 13 deletions(-)

(limited to 'system/doc/design_principles/appup_cookbook.xml')

diff --git a/system/doc/design_principles/appup_cookbook.xml b/system/doc/design_principles/appup_cookbook.xml
index bc61578953..eebe6ba7b4 100644
--- a/system/doc/design_principles/appup_cookbook.xml
+++ b/system/doc/design_principles/appup_cookbook.xml
@@ -4,7 +4,7 @@
 <chapter>
   <header>
     <copyright>
-      <year>2003</year><year>2009</year>
+      <year>2003</year><year>2011</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -603,25 +603,42 @@ code_change(_OldVsn, State, port) ->
   </section>
 
   <section>
-    <title>Emulator Restart</title>
-    <p>If the emulator can or should be restarted, the very simple
-      <c>.relup</c> file can be created manually:</p>
+    <title>Emulator Restart and Upgrade</title>
+    <p>There are two upgrade instructions that will restart the emulator:</p>
+    <taglist>
+      <tag><c>restart_new_emulator</c></tag>
+      <item>Intended for when erts, kernel, stdlib or sasl is
+        upgraded. It is automatically added when the relup file is
+        generated by <c>systools:make_relup/3,4</c>. It is executed
+        before all other upgrade instructions. See
+        <seealso marker="release_handling#restart_new_emulator_instr">Release
+        Handling</seealso> for more information about this
+        instruction.</item>
+      <tag><c>restart_emulator</c></tag>
+      <item>Used when a restart of the emulator is required after all
+        other upgrade instructions are executed. See
+        <seealso marker="release_handling#restart_emulator_instr">Release
+        Handling</seealso> for more information about this
+        instruction.</item>
+    </taglist>
+
+    <p>If an emulator restart is necessary and no upgrade instructions
+      are needed, i.e. if the restart itself is enough for the
+      upgraded applications to start running the new versions, a very
+      simple <c>.relup</c> file can be created manually:</p>
     <code type="none">
 {"B",
  [{"A",
    [],
-   [restart_new_emulator]}],
+   [restart_emulator]}],
  [{"A",
    [],
-   [restart_new_emulator]}]
+   [restart_emulator]}]
 }.</code>
-    <p>This way, the release handler framework with automatic packing
-      and unpacking of release packages, automatic path updates etc. can
-      be used without having to specify <c>.appup</c> files.</p>
-    <p>If some transformation of persistent data, for example database
-      contents, needs to be done before installing the new release
-      version, instructions for this can be added to the <c>.relup</c>
-      file as well.</p>
+    <p>In this case, the release handler framework with automatic
+      packing and unpacking of release packages, automatic path
+      updates etc. can be used without having to specify <c>.appup</c>
+      files.</p>
   </section>
 </chapter>
 
-- 
cgit v1.2.3