[libvirt] [PATCH] virsh: Update docs for block related commands

[Eric Blake]

On 11/29/2011 02:03 AM, Osier Yang wrote:
> commit 3ac26e26 allows to lookup the disk via both target name
> and source path. But virsh documents were not updated.
> ---
>  tools/virsh.c   |   15 ++++++++++-----
>  tools/virsh.pod |   14 +++++++++-----
>  2 files changed, 19 insertions(+), 10 deletions(-)
> 
> diff --git a/tools/virsh.c b/tools/virsh.c
> index 27ecaf3..94b5478 100644
> --- a/tools/virsh.c
> +++ b/tools/virsh.c
> @@ -1059,7 +1059,8 @@ static const vshCmdInfo info_domblkstat[] = {
>  
>  static const vshCmdOptDef opts_domblkstat[] = {
>      {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
> -    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
> +    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified source path or unique "
> +                                              "target name of the block device")},

This is a bit verbose.  Help output tends to be terse, and "block
device" is still an accurate name (meaning either fully-qualified path,
or unique target name).

> +++ b/tools/virsh.pod
> @@ -569,14 +569,16 @@ image has been pulled, the disk no longer depends on the backing image.
>  It pulls data for the entire disk in the background, the process of the
>  operation can be checked with B<blockjob>.
>  
> -I<path> specifies fully-qualified path of the disk.
> +I<path> specifies fully-qualified source path (<source file='name'/>) or
> +unique target name (<target dev='name'/>) of the disk.
>  I<bandwidth> specifies copying bandwidth limit in Mbps.

But I like these changes to the man page.

>  =item B<blockresize> I<domain> I<--path> I<--size>
>  
> -Resize a block device of domain while the domain is running, I<--path>
> -specifies the absolute path of the block device, I<--size> specifies the
> -new size in kilobytes
> +Resize a block device of domain while the domain is running.
> +
> +I<path> specifies fully-qualified source path (<source file='name'/>) or
> +unique target name (<target dev='name'/>) of the disk.
> +I<--size> specifies the new size in kilobytes.

Good - I just checked that your new block resize series properly hooked
into the name lookup, and supports both conventions.

-- 
Eric Blake   eblake at redhat.com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

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