[libvirt] [PATCH] virsh: Update docs for block related commands
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")}, {"human", VSH_OT_BOOL, 0, N_("print a more human readable output")}, {NULL, 0, 0, NULL} }; @@ -1637,7 +1638,8 @@ static const vshCmdInfo info_domblkinfo[] = { static const vshCmdOptDef opts_domblkinfo[] = { {"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")}, {NULL, 0, 0, NULL} }; @@ -5959,7 +5961,8 @@ static const vshCmdInfo info_block_pull[] = { static const vshCmdOptDef opts_block_pull[] = { {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")}, - {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")}, + {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified source path or unique " + "target name of the disk")}, {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Bandwidth limit in MB/s")}, {NULL, 0, 0, NULL} }; @@ -5983,7 +5986,8 @@ static const vshCmdInfo info_block_job[] = { static const vshCmdOptDef opts_block_job[] = { {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")}, - {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")}, + {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified source path or unique" + "target name of the disk")}, {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Abort the active job on the speficied disk")}, {"info", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Get active job information for the specified disk")}, {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Set the Bandwidth limit in MB/s")}, @@ -6039,7 +6043,8 @@ static const vshCmdInfo info_block_resize[] = { static const vshCmdOptDef opts_block_resize[] = { {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")}, - {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of block device")}, + {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified source path or unique " + "target name of the block device")}, {"size", VSH_OT_INT, VSH_OFLAG_REQ, N_("New size of the block device in kilobytes, " "the size must be integer")}, {NULL, 0, 0, NULL} diff --git a/tools/virsh.pod b/tools/virsh.pod index a5758f4..61951e6 100644 --- a/tools/virsh.pod +++ 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. =item B<blockjob> I<domain> I<path> [I<--abort>] [I<--info>] [I<bandwidth>] Manage active block operations. -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. If I<--abort> is specified, the active job on the specified disk will be aborted. If I<--info> is specified, the active job information on the specified @@ -585,9 +587,11 @@ I<bandwidth> can be used to set bandwidth limit for the active job. =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. =item B<dominfo> I<domain-id> -- 1.7.7.3
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@redhat.com +1-919-301-3266 Libvirt virtualization library http://libvirt.org
participants (2)
-
Eric Blake -
Osier Yang