From nobody Sat May 4 00:55:57 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.61 as permitted sender) client-ip=205.139.110.61; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 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=1584103933; cv=none; d=zohomail.com; s=zohoarc; b=ESkvSqabnLCqen6JGJpSLW5DU534ga9fhwTxbG+GEXwv2qXZMc5GdGymC8XjeFMnTRD9l26kV//XfDsddr+D/DY9aiu/BeBTi0WN/UavY7Ok6DsnzN1ggEUKi2p2dVhnYTurSyOgjkQgLumWF2UDLpjSStjta62Fd+i/yAYEVfc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1584103933; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=xxgyL4Oqrmwd1J6wV/pAeJ/boU59Efizs3GMQwLvCAE=; b=WTp1MIXxqiAdQarzQbNWf3DFw/oE7s1l4P2S799Qp1JAXcDbJCuVk0g8S5nKsqiCkovAUqNbn2krogNj9TVJbeLdBAsIuPlwhy1sDChbqY1kQeWmQaFeHCFzNUqy6UUsL54xi4CV2DsgFN6sbkMRgJ8hITaA/tvd/YNM1+GmARQ= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.61 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-delivery-1.mimecast.com (us-smtp-2.mimecast.com [205.139.110.61]) by mx.zohomail.com with SMTPS id 1584103933747858.244327218983; Fri, 13 Mar 2020 05:52:13 -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-442-V1PBz-YxMSmbC4W549LiRg-1; Fri, 13 Mar 2020 08:52:10 -0400 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9FBAC18FE860; Fri, 13 Mar 2020 12:52:04 +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 CDF601001B34; Fri, 13 Mar 2020 12:52:01 +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 6E6FE85EC4; Fri, 13 Mar 2020 12:51:58 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 02DCpunx002543 for ; Fri, 13 Mar 2020 08:51:56 -0400 Received: by smtp.corp.redhat.com (Postfix) id 3EA531001B34; Fri, 13 Mar 2020 12:51:56 +0000 (UTC) Received: from paraplu.localdomain (unknown [10.36.118.137]) by smtp.corp.redhat.com (Postfix) with ESMTP id 957481001902; Fri, 13 Mar 2020 12:51:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1584103932; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=xxgyL4Oqrmwd1J6wV/pAeJ/boU59Efizs3GMQwLvCAE=; b=IojqcJ/xzsC0qRKtRTGJMkoQwERjuco87C3vwo5EpK8sj7tBeg3LIGKDH8WCx+Gd43ec2p AM0QAG/bUMSW8dmr32ubn2Eg/sOSY/nnS0B4yxUQfoGTtyF5K7VW0lG+kHD95U5YiVxKs7 lEFToxLc1nWGL9tkfDtE3ZB+djkIMWU= X-MC-Unique: V1PBz-YxMSmbC4W549LiRg-1 From: Kashyap Chamarthy To: libvir-list@redhat.com Subject: [libvirt PATCH] docs: Fix blockCopy's documentation on --pivot & --abort flags Date: Fri, 13 Mar 2020 13:51:51 +0100 Message-Id: <20200313125151.4175-1-kchamart@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-loop: libvir-list@redhat.com 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.84 on 10.5.11.22 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" The --abort and --pivot flags for ``blockjob`` are mutually exclusive =E2=80=94 you either abort and keep the destination copy as a point-in-time "snapshot"; or pivot to the new copy. But you cannot specify both flags at once. Rephrase blockCopy's doc fragment to that effect. Signed-off-by: Kashyap Chamarthy --- docs/manpages/virsh.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index dc404ddfe8..e7d4933c93 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -1254,18 +1254,19 @@ phases. Initially, the job must copy all data from= the source, and during this phase, the job can only be canceled to revert back to the source disk, with no guarantees about the destination. After this phase completes, both the source and the destination remain mirrored until a -call to ``blockjob`` with the *--abort* and *--pivot* flags pivots over -to the copy, or a call without *--pivot* leaves the destination as a -faithful copy of that point in time. However, if *--wait* is specified, -then this command will block until the mirroring phase begins, or cancel -the operation if the optional *timeout* in seconds elapses or SIGINT is -sent (usually with ``Ctrl-C``). Using *--verbose* along with *--wait* -will produce periodic status updates. Using *--pivot* (similar to -``blockjob`` *--pivot*) or *--finish* (similar to ``blockjob`` *--abort*) -implies *--wait*, and will additionally end the job cleanly rather than -leaving things in the mirroring phase. If job cancellation is triggered -by timeout or by *--finish*, *--async* will return control to the user -as fast as possible, otherwise the command may continue to block a little +call is issued to ``blockjob`` with either the *--abort* flag, which +leaves the destination as a faithful copy of that point in time; or the +*--pivot* flag, which pivots over to the copy on the destination. +However, if *--wait* is specified, then this command will block until +the mirroring phase begins, or cancel the operation if the optional +*--timeout* in seconds elapses or SIGINT is sent (usually with +``Ctrl-C``). Using *--verbose* along with *--wait* will produce +periodic status updates. Using *--pivot* (similar to ``blockjob`` +*--pivot*) or *--finish* (similar to ``blockjob`` *--abort*) implies +*--wait*, and will additionally end the job cleanly rather than leaving +things in the mirroring phase. If job cancellation is triggered by +timeout or by *--finish*, *--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 has actually cancelled. =20 *path* specifies fully-qualified path of the disk. --=20 2.21.0