From 3fb71895e808450737f44111a73e89b4d5cb7633 Mon Sep 17 00:00:00 2001 From: Justin Clift Date: Fri, 29 Oct 2010 11:50:15 +1100 Subject: [PATCH] virsh: improve the help description for managedsave and start 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 | 9 +++++++-- tools/virsh.pod | 18 +++++++++--------- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/tools/virsh.c b/tools/virsh.c index a182d4c11d..b485eff190 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -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} }; diff --git a/tools/virsh.pod b/tools/virsh.pod index d904800f07..5932aaa118 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -433,15 +433,14 @@ variables, and defaults to C. =item B I -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 command is next run for +the domain, it will automatically be started from this saved state. =item B I -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 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 optional I @@ -562,9 +561,10 @@ I parameter in the domain's XML definition. =item B I 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 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 I