From 3bf2f7607c38c9499337f28c317072d9bbb61801 Mon Sep 17 00:00:00 2001 From: John Ferlan Date: Mon, 12 Mar 2018 15:18:06 -0400 Subject: [PATCH] virsh: Fix man page argument ordering for vol-download command The proper command order is 'virsh vol-download volume file 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 --- tools/virsh.pod | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 531cfefe5f..f48b970e5a 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -4104,19 +4104,28 @@ See the description for the libvirt virStorageVolUpload API for details regarding possible target volume and pool changes as a result of the pool refresh when the upload is attempted. -=item B [I<--pool> I] [I<--offset> I] -[I<--length> I] [I<--sparse>] I I +=item B I I +[I<--pool> I] [I<--offset> I] [I<--length> I] +[I<--sparse>] Download the contents of a storage volume to I. + +I is the name or key or path of the volume to +download into I. + I<--pool> I is the name or UUID of the storage pool the volume -is in. -I is the name or key or path of the volume to download. -If I<--sparse> is specified, this command will preserve volume sparseness. +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. + I<--offset> is the position in the storage volume at which to start reading -the data. The value must be 0 or larger. I<--length> is an upper bound of -the amount of data to be downloaded. A negative value is interpreted as -an unsigned long long value to essentially include everything from the -offset to the end of the volume. +the data. The value must be 0 or larger. + +I<--length> is an upper bound of the amount of data to be downloaded. +A negative value is interpreted as an unsigned long long value to +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