From nobody Wed May 14 19:36:38 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) client-ip=209.132.183.28; envelope-from=libvir-list-bounces@redhat.com; helo=mx1.redhat.com; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of redhat.com designates 209.132.183.28 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by mx.zohomail.com with SMTPS id 1520889141461392.15685652743196; Mon, 12 Mar 2018 14:12:21 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 09E3828208; Mon, 12 Mar 2018 21:12:20 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id D5B9160F82; Mon, 12 Mar 2018 21:12:19 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 9B3EA4CA9C; Mon, 12 Mar 2018 21:12:19 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id w2CLCD8i028751 for ; Mon, 12 Mar 2018 17:12:13 -0400 Received: by smtp.corp.redhat.com (Postfix) id 97C9317AB4; Mon, 12 Mar 2018 21:12:13 +0000 (UTC) Received: from unknown54ee7586bd10.attlocal.net.com (ovpn-116-66.phx2.redhat.com [10.3.116.66]) by smtp.corp.redhat.com (Postfix) with ESMTP id 550F1608EE for ; Mon, 12 Mar 2018 21:12:13 +0000 (UTC) From: John Ferlan To: libvir-list@redhat.com Date: Mon, 12 Mar 2018 17:11:52 -0400 Message-Id: <20180312211158.28343-6-jferlan@redhat.com> In-Reply-To: <20180312211158.28343-1-jferlan@redhat.com> References: <20180312211158.28343-1-jferlan@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-loop: libvir-list@redhat.com Subject: [libvirt] [PATCH 05/11] virsh: Fix man page argument ordering for vol-download command X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Mon, 12 Mar 2018 21:12:20 +0000 (UTC) X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Type: text/plain; charset="utf-8" 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 db871db9e..d8cc64f36 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -4103,19 +4103,28 @@ See the description for the libvirt virStorageVolUp= load API for details regarding possible target volume and pool changes as a result of the pool refresh when the upload is attempted. =20 -=3Ditem B [I<--pool> I] [I<--offset> I] -[I<--length> I] [I<--sparse>] I I +=3Ditem B I I +[I<--pool> I] [I<--offset> I] [I<--length> I] +[I<--sparse>] =20 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 volu= me -is in. -I is the name or key or path of the volume to dow= nload. -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. =20 =3Ditem B [I<--pool> I] [I<--algorithm> I] I --=20 2.13.6 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list