]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
virsh: Fix man page argument ordering for vol-wipe command
authorJohn Ferlan <jferlan@redhat.com>
Mon, 12 Mar 2018 17:14:18 +0000 (13:14 -0400)
committerJohn Ferlan <jferlan@redhat.com>
Thu, 15 Mar 2018 21:11:37 +0000 (17:11 -0400)
The proper command order is 'virsh vol-wipe volume pool algorithm'. 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 f48b970e5aeab6af16f1d398bde7ac65a010a7b6..0a6d4e55193822a38abacdbd74dcf223bb8d73e0 100644 (file)
@@ -4127,15 +4127,23 @@ essentially include everything from the offset to the end of the volume.
 
 If I<--sparse> is specified, this command will preserve volume sparseness.
 
-=item B<vol-wipe> [I<--pool> I<pool-or-uuid>] [I<--algorithm> I<algorithm>]
-I<vol-name-or-key-or-path>
+=item B<vol-wipe> I<vol-name-or-key-or-path> [I<--pool> I<pool-or-uuid>]
+[I<--algorithm> I<algorithm>]
 
 Wipe a volume, ensure data previously on the volume is not accessible to
-future reads. I<--pool> I<pool-or-uuid> is the name or UUID of the storage
-pool the volume is in.
+future reads.
+
 I<vol-name-or-key-or-path> is the name or key or path of the volume to wipe.
 It is possible to choose different wiping algorithms instead of re-writing
-volume with zeroes. This can be done via I<--algorithm> switch.
+volume with zeroes.
+
+I<--pool> I<pool-or-uuid> is the name or UUID of the storage pool the
+volume 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 wiped;
+otherwise, the first volume found by the key or path will be used.
+
+Use the I<--algorithm> switch choosing from the list of the following
+algorithms in order to define which algorithm to use for the wipe.
 
 B<Supported algorithms>
   zero       - 1-pass all zeroes