[libvirt] [PATCH 07/11] virsh: Fix man page argument ordering for vol-dumpxml command
The proper command order is 'virsh vol-dumpxml 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(a)redhat.com>
---
tools/virsh.pod | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 24177e407..135cce841 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -4178,12 +4178,17 @@ it expects the storage driver to be able to discard all bytes in
a
volume. It is up to the storage driver to handle how the discarding
occurs. Not all storage drivers or volume types can support 'trim'.
-=item B<vol-dumpxml> [I<--pool> I<pool-or-uuid>]
I<vol-name-or-key-or-path>
+=item B<vol-dumpxml> I<vol-name-or-key-or-path> [I<--pool>
I<pool-or-uuid>]
Output the volume information as an XML dump to stdout.
+
+I<vol-name-or-key-or-path> is the name or key or path of the volume
+to output the XML.
+
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 output the XML of.
+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>
[I<--bytes>] [I<--physical>]
--
2.13.6