From: John Ferlan Date: Mon, 12 Mar 2018 17:14:18 +0000 (-0400) Subject: virsh: Fix man page argument ordering for vol-wipe command X-Git-Tag: v4.2.0-rc1~133 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=442f8b44c2468259fbc98b23abbffb1ab87699ea;p=thirdparty%2Flibvirt.git 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 --- diff --git a/tools/virsh.pod b/tools/virsh.pod index f48b970e5a..0a6d4e5519 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -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 [I<--pool> I] [I<--algorithm> I] -I +=item B I [I<--pool> I] +[I<--algorithm> I] Wipe a volume, ensure data previously on the volume is not accessible to -future reads. I<--pool> I is the name or UUID of the storage -pool the volume is in. +future reads. + I 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 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 zero - 1-pass all zeroes