]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
virsh: Fix man page argument ordering for vol-dumpxml command
authorJohn Ferlan <jferlan@redhat.com>
Mon, 12 Mar 2018 19:45:28 +0000 (15:45 -0400)
committerJohn Ferlan <jferlan@redhat.com>
Thu, 15 Mar 2018 21:11:38 +0000 (17:11 -0400)
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@redhat.com>
tools/virsh.pod

index 0a6d4e55193822a38abacdbd74dcf223bb8d73e0..6063c1b6bf8ae8caeca894776415ac41b12e8fe4 100644 (file)
@@ -4179,12 +4179,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>]