[libvirt] [PATCH] virsh: improve the help description for managedsave and start

[Eric Blake]

On 10/27/2010 10:53 PM, Justin Clift wrote:
> ---
> Note that this includes carriage returns in the output string at

Actually, \n is newline; \r is carriage return.

> appropriate locations.  This lets us have reasonably verbose
> output, with good descriptions of the purpose of each command,
> that also looks decent without wrapping.
>  tools/virsh.c |    9 +++++++--
>  1 files changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/virsh.c b/tools/virsh.c
> index a182d4c..11efaea 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.")},

ACK - both descriptions look okay to me.  But before you push, be sure
virsh.pod also has similar wording.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 619 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20101028/b7e697e4/attachment-0001.sig>