External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-08-04 07:53:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

virsh: improve the help description for managedsave and start

Browse Source 
Updated the descriptions for managedsave and start in virsh and
the virsh man page, and also for managedsave-remove in the virsh
man page.
This commit is contained in:
Justin Clift 2010-10-29 11:50:15 +11:00
parent 5546034210
commit 3fb71895e8
2 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tools/virsh.c
View File

@ -1359,7 +1359,9 @@ cmdUndefine(vshControl *ctl, const vshCmd *cmd)
*/ */
static const vshCmdInfo info_start[] = { static const vshCmdInfo info_start[] = {
{"help", N_("start a (previously defined) inactive domain")}, {"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} {NULL, NULL}
}; };
@ -1462,7 +1464,10 @@ cmdSave(vshControl *ctl, const vshCmd *cmd)
*/ */
static const vshCmdInfo info_managedsave[] = { static const vshCmdInfo info_managedsave[] = {
{"help", N_("managed save of a domain state")}, {"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} {NULL, NULL}
}; };

18
tools/virsh.pod
View File

@ -433,15 +433,14 @@ variables, and defaults to C<vi>.
=item B<managedsave> I<domain-id> =item B<managedsave> I<domain-id>
Ask libvirt to save a running domain state in a place managed by libvirt. Save and destroy a running domain, so it can be restarted from the same
If libvirt is asked to restart the domain later on it will resume it from state at a later time. When the virsh B<start> command is next run for
the saved domain state (and the state is discarded). the domain, it will automatically be started from this saved state.
=item B<managedsave-remove> I<domain-id> =item B<managedsave-remove> I<domain-id>
Remove the managed save file for a domain if it exists. The next time the Remove the B<managedsave> state file for a domain, if it exists. This
domain is started it will not restore to its previous state but instead will ensures the domain will do a full boot the next time it is started.
do a full boot.
=item B<maxvcpus> optional I<type> =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> =item B<start> I<domain-name> optional I<--console> I<--paused>
Start a (previously defined) inactive domain. The domain will be paused Start a (previously defined) inactive domain, either from the last
if the I<--paused> option is used and supported by the driver; otherwise B<managedsave> state, or via a fresh boot if no managedsave state is
it will be running. 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. If I<--console> is requested, attach to the console after creation.
=item B<suspend> I<domain-id> =item B<suspend> I<domain-id>