From nobody Mon Feb 9 06:25:43 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) client-ip=207.211.31.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1586950475; cv=none; d=zohomail.com; s=zohoarc; b=Olr31gydL6lGUc6isUAw0zOnp6foOL3NZqMigHW/j7ozpmaI0hUIP1M6PXDZODuIVNZoLpKn8n2AUjU5okZGHuk8WI9ebzGHPX3Nby8XTr7GMJGdyJ4D+WmnbaOcuBuk/YQuS2H5IWUQLcE8gBBLpJvowGbREPGB2svrzCs2Z1A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1586950475; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=aDBclnxDPlWNbjXT2n3eXpwciT+k/HqbyHKiNUTbAtU=; b=Uy7wBcypZ6r3bigz1em3tBbULahIJTJuJ7mP/5w36uH6t7JjAgU8BbjMQ1iV40kxzL2Nq9PMxDQ0x1UfKgOJNX1NzpV5AbyqSoMGeXMy6oCj2tlUctGF3f4RueVMMH0kBu/hsZ37OJcLiF9CbfETZsH3xCWsdZTKp1aEnTpH/Rs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 207.211.31.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.120]) by mx.zohomail.com with SMTPS id 1586950475506127.90236862599272; Wed, 15 Apr 2020 04:34:35 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-319-rMsvAY22NbachVPiGvFfiQ-1; Wed, 15 Apr 2020 07:34:32 -0400 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 mimecast-mx01.redhat.com (Postfix) with ESMTPS id 92845800D5B; Wed, 15 Apr 2020 11:34:26 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.20]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E894760BE2; Wed, 15 Apr 2020 11:34:25 +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 0A11018089CE; Wed, 15 Apr 2020 11:34:23 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 03FBYLAF026197 for ; Wed, 15 Apr 2020 07:34:21 -0400 Received: by smtp.corp.redhat.com (Postfix) id 73BEB116D9E; Wed, 15 Apr 2020 11:34:21 +0000 (UTC) Received: from localhost.localdomain (ovpn-112-140.ams2.redhat.com [10.36.112.140]) by smtp.corp.redhat.com (Postfix) with ESMTP id E217C6EF92; Wed, 15 Apr 2020 11:34:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1586950474; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=aDBclnxDPlWNbjXT2n3eXpwciT+k/HqbyHKiNUTbAtU=; b=MEQXeNk4QlMnmh0QOlMcUl1ynF+qXxGVbvOe/b8ea8nX0RC0K9UwIZZZW16RpEii+oxJy5 Z7eCqbJ4y6/ZOaoY/r+vvFxEAKyVa8BHyaqhRb7mmCCgdv6hHHlB7UCeSRZcg0hqLxcIN5 1I/n/D+tgbIGO6TS9cBJcSPLT6b4+fk= X-MC-Unique: rMsvAY22NbachVPiGvFfiQ-1 From: Sebastian Mitterle To: libvir-list@redhat.com Subject: [PATCH 1/3] Improve blockpull man entry Date: Wed, 15 Apr 2020 11:34:04 +0000 Message-Id: <20200415113406.34823-2-smitterl@redhat.com> In-Reply-To: <20200415113406.34823-1-smitterl@redhat.com> References: <20200415113406.34823-1-smitterl@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 X-loop: libvir-list@redhat.com Cc: Sebastian Mitterle 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: , 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-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" 1. Mention usage of `--base` and `--bandwidth` and fix cmd syntax. 2. Explain valid arguments for `base`. 3. Move explanation for `--keep-relative` to end considering it less frequent use case because libvirt doesn't create relative backing chain names. 4. Add reference to documentation for relative paths in backing chains. Signed-off-by: Sebastian Mitterle --- docs/manpages/virsh.rst | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index dc404ddfe8..27ecc53d56 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -1345,7 +1345,7 @@ blockpull =20 .. code-block:: =20 - blockpull domain path [bandwidth] [--bytes] [base] + blockpull domain path { [bandwidth [--bytes] [base]] | [--bandwidth [--= bytes]] [--base] } [--wait [--verbose] [--timeout seconds] [--async]] [--keep-relative] =20 @@ -1353,7 +1353,7 @@ Populate a disk from its backing image chain. By defa= ult, this command flattens the entire chain; but if *base* is specified, containing the name of one of the backing files in the chain, then that file becomes the new backing file and only the intermediate portion of the chain is -pulled. Once all requested data from the backing image chain has been +pulled. Once all requested data from the backing image chain has been pulled, the disk no longer depends on that portion of the backing chain. =20 By default, this command returns as soon as possible, and data for @@ -1367,16 +1367,23 @@ is triggered, *--async* will return control to the = user as fast as possible, otherwise the command may continue to block a little while longer until the job is done cleaning up. =20 -Using the *--keep-relative* flag will keep the backing chain names -relative. - *path* specifies fully-qualified path of the disk; it corresponds to a unique target name () or source file () for one of the disk devices attached to *domain* (see also ``domblklist`` for listing these names). + *bandwidth* specifies copying bandwidth limit in MiB/s. For further inform= ation on the *bandwidth* argument see the corresponding section for the ``blockj= ob`` -command. +command. Using *--bytes* flag indicates the value in *bandwidth* is given = in +bytes. + +*base* specifies fully-qualified path of the backing file; it corresponds +to a unique indexed target name 'name[i]' (.. +) or source file 'name' (). + +Using the *--keep-relative* flag will keep the backing chain names +relative (details on `https://www.libvirt.org/kbase/backing_chains.html +`__). =20 =20 blockresize --=20 2.25.2