]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
virsh: improve the help description for managedsave and start
authorJustin Clift <jclift@redhat.com>
Fri, 29 Oct 2010 00:50:15 +0000 (11:50 +1100)
committerJustin Clift <jclift@redhat.com>
Fri, 29 Oct 2010 00:52:31 +0000 (11:52 +1100)
Updated the descriptions for managedsave and start in virsh and
the virsh man page, and also for managedsave-remove in the virsh
man page.

tools/virsh.c
tools/virsh.pod

index a182d4c11d60c818ab26a679a03b3a66e2199568..b485eff1908d8abe4eef06d1c5b9507d5662bffe 100644 (file)
@@ -1359,7 +1359,9 @@ cmdUndefine(vshControl *ctl, const vshCmd *cmd)
  */
 static const vshCmdInfo info_start[] = {
     {"help", N_("start a (previously defined) inactive domain")},
-    {"desc", N_("Start a domain.")},
+    {"desc", N_("Start a domain, either from the last managedsave\n"
+                "    state, or via a fresh boot if no managedsave state\n"
+                "    is present.")},
     {NULL, NULL}
 };
 
@@ -1462,7 +1464,10 @@ cmdSave(vshControl *ctl, const vshCmd *cmd)
  */
 static const vshCmdInfo info_managedsave[] = {
     {"help", N_("managed save of a domain state")},
-    {"desc", N_("Save and stop a running domain, so libvirt can restart it from the same state")},
+    {"desc", N_("Save and destroy a running domain, so it can be restarted from\n"
+                "    the same state at a later time.  When the virsh 'start'\n"
+                "    command is next run for the domain, it will automatically\n"
+                "    be started from this saved state.")},
     {NULL, NULL}
 };
 
index d904800f07c5f48f3f5439703dc6f0d0ed489f54..5932aaa1182094b4b8014621a115ac30db338990 100644 (file)
@@ -433,15 +433,14 @@ variables, and defaults to C<vi>.
 
 =item B<managedsave> I<domain-id>
 
-Ask libvirt to save a running domain state in a place managed by libvirt.
-If libvirt is asked to restart the domain later on it will resume it from
-the saved domain state (and the state is discarded).
+Save and destroy a running domain, so it can be restarted from the same
+state at a later time.  When the virsh B<start> command is next run for
+the domain, it will automatically be started from this saved state.
 
 =item B<managedsave-remove> I<domain-id>
 
-Remove the managed save file for a domain if it exists.  The next time the
-domain is started it will not restore to its previous state but instead will
-do a full boot.
+Remove the B<managedsave> state file for a domain, if it exists.  This
+ensures the domain will do a full boot the next time it is started.
 
 =item B<maxvcpus> optional I<type>
 
@@ -562,9 +561,10 @@ I<on_shutdown> parameter in the domain's XML definition.
 
 =item B<start> I<domain-name> optional I<--console> I<--paused>
 
-Start a (previously defined) inactive domain.  The domain will be paused
-if the I<--paused> option is used and supported by the driver; otherwise
-it will be running.
+Start a (previously defined) inactive domain, either from the last
+B<managedsave> state, or via a fresh boot if no managedsave state is
+present.  The domain will be paused if the I<--paused> option is
+used and supported by the driver; otherwise it will be running.
 If I<--console> is requested, attach to the console after creation.
 
 =item B<suspend> I<domain-id>