[libvirt] [v2] qemu: Improve docs for virsh dump format

[Eric Blake]

On 07/27/2011 04:58 AM, Osier Yang wrote:
> The error in getCompressionType will never be reported, change
> the errors codes into warning (VIR_WARN("%s", _(foo)); doesn't break
> syntax-check rule), and also improve the docs in qemu.conf to tell
> user the truth.
> ---
>   src/qemu/qemu.conf     |   10 ++++++++--
>   src/qemu/qemu_driver.c |   15 ++++++++-------
>   2 files changed, 16 insertions(+), 9 deletions(-)
>
> diff --git a/src/qemu/qemu.conf b/src/qemu/qemu.conf
> index 145062c..7de6863 100644
> --- a/src/qemu/qemu.conf
> +++ b/src/qemu/qemu.conf
> @@ -196,8 +196,14 @@
>   # saving a domain in order to save disk space; the list above is in descending
>   # order by performance and ascending order by compression ratio.
>   #
> -# save_image_format is used when you use 'virsh save' at scheduled saving.
> -# dump_image_format is used when you use 'virsh dump' at emergency crashdump.
> +# save_image_format is used when you use 'virsh save' at scheduled
> +# saving, and it is an error if the specified save_image_format is
> +# not valid, or the according compression program can't be found.

s/according/requested/

> +#
> +# dump_image_format is used when you use 'virsh dump' at emergency
> +# crashdump, and if the specified dump_image_format is not valid, or
> +# the according compression program can't be found, this falls

s/according/requested/

> +++ b/src/qemu/qemu_driver.c
> @@ -2712,17 +2712,18 @@ getCompressionType(struct qemud_driver *driver)
>        */
>       if (driver->dumpImageFormat) {
>           compress = qemudSaveCompressionTypeFromString(driver->dumpImageFormat);
> +        /* Use "raw" as the format if the specified format is not valid,
> +         * or the compress program is not available,
> +         */

s/,/./ at the comment end.

ACK with those nits fixed.

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