From nobody Wed May 14 19:35:33 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 1520889142178262.7631553232999; Mon, 12 Mar 2018 14:12:22 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 3BA3E28210; 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 0D8BE17D38; Mon, 12 Mar 2018 21:12:20 +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 BF63D4CA9D; 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 w2CLCFbY028791 for ; Mon, 12 Mar 2018 17:12:16 -0400 Received: by smtp.corp.redhat.com (Postfix) id EC631608EE; Mon, 12 Mar 2018 21:12:15 +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 A69F617AD6 for ; Mon, 12 Mar 2018 21:12:15 +0000 (UTC) From: John Ferlan To: libvir-list@redhat.com Date: Mon, 12 Mar 2018 17:11:57 -0400 Message-Id: <20180312211158.28343-11-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 10/11] virsh: Fix man page argument ordering for vol-{path|name|key} commands 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.14 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-path volume pool', or 'virsh vol-name volume pool', or 'virsh vol-key volume'. 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 | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/tools/virsh.pod b/tools/virsh.pod index 1b59251bf..366a628f9 100644 --- a/tools/virsh.pod +++ b/tools/virsh.pod @@ -4231,24 +4231,34 @@ information. =20 If the I<--uuid> option is given, the pool UUID is returned instead. =20 -=3Ditem B [I<--pool> I] I +=3Ditem B I [I<--pool> I] =20 Return the path for a given volume. + +I is the name or key of the volume to return the path. + I<--pool> I is the name or UUID of the storage pool the volu= me -is in. -I is the name or key of the volume to return the path for. +is in. If the volume name is provided instead of the key, then providing +the pool is necessary to find the volume to be uploaded into; otherwise, +the first volume found by the key will be used. =20 =3Ditem B I =20 Return the name for a given volume. -I is the key or path of the volume to return the name for. =20 -=3Ditem B [I<--pool> I] I +I is the key or path of the volume to return the name. + +=3Ditem B I [I<--pool> I] =20 Return the volume key for a given volume. + +I is the name or path of the volume to return the +volume key. + I<--pool> I is the name or UUID of the storage pool the volu= me -is in. I is the name or path of the volume to return the -volume key for. +is in. If the volume name is provided instead of the path, then providing +the pool is necessary to find the volume to be uploaded into; otherwise, +the first volume found by the path will be used. =20 =3Ditem B I I [I<--pool> I] [I<--allocate>] [I<--delta>] [I<--shrink>] --=20 2.13.6 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list