[libvirt] [PATCH 06/11] virsh: Fix man page argument ordering for vol-wipe command

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(a)redhat.com&gt; --- tools/virsh.pod | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index d8cc64f36..24177e407 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -4126,15 +4126,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 -- 2.13.6