From: John Ferlan <jferlan@redhat.com>
Date: Mon, 12 Mar 2018 20:08:11 +0000 (-0400)
Subject: virsh: Fix man page argument ordering for vol-info command
X-Git-Tag: v4.2.0-rc1~131
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=216efc893fcf9410198061d7277478d79a6040f9;p=thirdparty%2Flibvirt.git

virsh: Fix man page argument ordering for vol-info command

The proper command order is 'virsh vol-info volume pool'. While
making the modification clean up the description a bit too in order
to help clarify under what circumstances the volume could be found
if the pool name was not provided.

Signed-off-by: John Ferlan <jferlan@redhat.com>
---

diff --git a/tools/virsh.pod b/tools/virsh.pod
index 6063c1b6bf..caaa62b840 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -4191,17 +4191,26 @@ is in. If the volume name is provided instead of the key or path, then
 providing the pool is necessary to find the volume to be uploaded into;
 otherwise, the first volume found by the key or path will be used.
 
-=item B<vol-info> [I<--pool> I<pool-or-uuid>] I<vol-name-or-key-or-path>
+=item B<vol-info> I<vol-name-or-key-or-path> [I<--pool> I<pool-or-uuid>]
 [I<--bytes>] [I<--physical>]
 
 Returns basic information about the given storage volume.
+
+I<vol-name-or-key-or-path> is the name or key or path of the volume
+to return information for.
+
 I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the volume
-is in. I<vol-name-or-key-or-path> is the name or key or path of the volume
-to return information for. If I<--bytes> is specified the sizes are not
-converted to human friendly units. If I<--physical> is specified, then the host
-physical size is returned and displayed instead of the allocation value. The
-physical value for some file types, such as qcow2 may have a different (larger)
-physical value than is shown for allocation. Additionally sparse files will
+is in. If the volume name is provided instead of the key or path, then
+providing the pool is necessary to find the volume to be uploaded into;
+otherwise, the first volume found by the key or path will be used.
+
+If I<--bytes> is specified the sizes are not converted to human friendly
+units.
+
+If I<--physical> is specified, then the host physical size is returned
+and displayed instead of the allocation value. The physical value for
+some file types, such as qcow2 may have a different (larger) physical
+value than is shown for allocation. Additionally sparse files will
 have different physical and allocation values.
 
 =item B<vol-list> [I<--pool> I<pool-or-uuid>] [I<--details>]