From: John Ferlan <jferlan@redhat.com>
Date: Tue, 23 Apr 2013 21:51:08 +0000 (-0400)
Subject: docs: Update formatdomain for lifecycle events
X-Git-Tag: CVE-2013-1962~19
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f60bd7c7a772985b2cab6dbc7214afc528d6dc93;p=thirdparty%2Flibvirt.git

docs: Update formatdomain for lifecycle events
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 8852d7d586..b118b49d1a 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -967,7 +967,13 @@
 
     <p>
       It is sometimes necessary to override the default actions taken
-      on various events.
+      on various events. Not all hypervisors support all events and actions.
+      The actions may be taken as a result of calls to libvirt APIs
+      <code class='docref'>virDomainReboot</code>,
+      <code class='docref'>virDomainShutdown</code>, or
+      <code class='docref'>virDomainShutdownFlags</code>.
+      Using <code>virsh reboot</code> or <code>virsh shutdown</code> would
+      also trigger the event.
     </p>
 
 <pre>
@@ -1004,20 +1010,29 @@
     <dl>
       <dt><code>destroy</code></dt>
       <dd>The domain will be terminated completely and all resources
-        released</dd>
+        released.</dd>
       <dt><code>restart</code></dt>
-      <dd>The domain will be terminated, and then restarted with
-        the same configuration</dd>
+      <dd>The domain will be terminated and then restarted with
+        the same configuration.</dd>
       <dt><code>preserve</code></dt>
-      <dd>The domain will be terminated, and its resource preserved
+      <dd>The domain will be terminated and its resource preserved
         to allow analysis.</dd>
       <dt><code>rename-restart</code></dt>
-      <dd>The domain will be terminated, and then restarted with
-        a new name</dd>
+      <dd>The domain will be terminated and then restarted with
+        a new name.</dd>
     </dl>
 
     <p>
-      on_crash supports these additional
+    QEMU/KVM supports the <code>on_poweroff</code> and <code>on_reboot</code>
+    events handling the <code>destroy</code> and <code>restart</code> actions.
+    The <code>preserve</code> action for an <code>on_reboot</code> event
+    is treated as a <code>destroy</code> and the <code>rename-restart</code>
+    action for an <code>on_poweroff</code> event is treated as a
+    <code>restart</code> event.
+    </p>
+
+    <p>
+      The <code>on_crash</code> event supports these additional
       actions <span class="since">since 0.8.4</span>.
     </p>