From nobody Sun Sep 7 23:35:47 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1756303105; cv=none; d=zohomail.com; s=zohoarc; b=ONRZF5DQk1BwIQ/1dANNkGKgJFnfXAK3upxuzBpDlFWGUVFWqSt3DMsEnhV/Fu8PLgBc2AmaLg46vuDSQ1bm+0c3sSLw/ZJyp4sNBlnIBJxaYiHmsNlCwUEjJyFUtATfPRUMRQ8y88lNlN9cVUpYspVCIkBvkw6hNqlFkzx2/tI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1756303105; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=U4r1oGDAho1NrMQtsDMuTdNt3qA/qoo66BtLJZMqO3E=; b=Lt76KekMzJFqjpkkxJQ5iehUvoQkMFNSaz7XPB6vBnymEnDTBD5PYp7tD/f2xi79cDC1Z7uM1cmeHmVwnPMjjGQcWwp5ss1f7MMAdo3cX861x65lPDf3W8QZ4eK2Qv2Hnzq8RDhaUFN3WAC3hur4UcBBkSJtQC0WJrPbGspftKg= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1756303105666903.3791523817387; Wed, 27 Aug 2025 06:58:25 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 9C78A43FF1; Wed, 27 Aug 2025 09:58:24 -0400 (EDT) Received: from [172.19.199.3] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id 463EC4409D; Wed, 27 Aug 2025 09:51:27 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 993) id E544C43F8D; Wed, 27 Aug 2025 09:51:18 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 5C4C543F74 for ; Wed, 27 Aug 2025 09:51:14 -0400 (EDT) Received: from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-637-3X-NBD51MFig3_RPwk9DQg-1; Wed, 27 Aug 2025 09:51:12 -0400 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 0FB5318002C5 for ; Wed, 27 Aug 2025 13:51:12 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.44.22.3]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 42F8318003FC for ; Wed, 27 Aug 2025 13:51:11 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-1.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1756302674; h=from:from: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: in-reply-to:in-reply-to:references:references; bh=U4r1oGDAho1NrMQtsDMuTdNt3qA/qoo66BtLJZMqO3E=; b=PnFVAPsbAKWrE4Ha4U82ElQnBGUJCTDy0QJwA7wHjJDwc9xMsol7ckmA5SJ3v5L8vyQP+o qq1f99MyTBRhcaaV7VZejSpgLUxUZiLHKiN+CEeVfBjl9OZqYYWa2TKF0rv7ICC6SB5nyR s47Q3uj9caLjg7tBdDmM7q+d68xZqHY= X-MC-Unique: 3X-NBD51MFig3_RPwk9DQg-1 X-Mimecast-MFC-AGG-ID: 3X-NBD51MFig3_RPwk9DQg_1756302672 To: devel@lists.libvirt.org Subject: [PATCH 1/4] kbase: live_full_disk_backup: Fix use of '.. note' directive Date: Wed, 27 Aug 2025 15:51:05 +0200 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: dJS0kZi-5f6kGnIrCK5WdjHsceDyVg8MfzMR0gOhKD4_1756302672 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: VNOB3WZ23JT7BDPW3DOJZQHMETKRB766 X-Message-ID-Hash: VNOB3WZ23JT7BDPW3DOJZQHMETKRB766 X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1756303109270124100 Content-Type: text/plain; charset="utf-8" From: Peter Krempa The note was misindented thus breaking the numbered list around. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/kbase/live_full_disk_backup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_di= sk_backup.rst index f9dcd2a1bd..c545aa3009 100644 --- a/docs/kbase/live_full_disk_backup.rst +++ b/docs/kbase/live_full_disk_backup.rst @@ -126,7 +126,7 @@ it. base.raw <-- overlay1.qcow2 (live QEMU) - .. note:: + .. note:: Above, if you have QEMU guest agent installed in your virtual machine, use the ``--quiesce`` option with ``virsh snapshot-create-as [...]`` to ensure you have a consistent disk --=20 2.51.0 From nobody Sun Sep 7 23:35:47 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1756303343; cv=none; d=zohomail.com; s=zohoarc; b=EAD3TLlkK6mFjjOyu3nXC6sMhGyPcqBsVDVyllp47cGH9fBDrxWUZMcDX71tNRj7Dl1zp/WgkP7+h4OdtRRvgiFjh99/4FgQIP0HDnjmcQ6W2zgiFmiOa4K3uJaKDygbDh4mIr+Ags4pOGlL69UEXHpdOiuiA/fsW/6jVdnWEVU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1756303343; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=lCrZcUpo93wopfPsT8mXqdlKPRFuPPB7h+06167eOX8=; b=R5zx1zLh6m+s7dphIqGK158A9tBKs8SILxXg2wdVQjg2s/nYbs1nmwXF2Fc1HX9lcyo5pW3vTXNYc/uMJmGg58vkxILGuiEOiCOX6UxfqUoYmtiOpRqYnQxdT33VDHt1qaXVOzUPOhgMaE6Vy4xXQTWl6cc9J3+3kKi8rCVlt6A= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1756303343296178.57782793218428; Wed, 27 Aug 2025 07:02:23 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 54CA5440B8; Wed, 27 Aug 2025 10:02:22 -0400 (EDT) Received: from [172.19.199.3] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id 1E2B1440EE; Wed, 27 Aug 2025 09:51:30 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 9702444038; Wed, 27 Aug 2025 09:51:21 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id B618643F8E for ; Wed, 27 Aug 2025 09:51:15 -0400 (EDT) Received: from mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-639-LuECJAqVPH-oyo1FS3X5Gw-1; Wed, 27 Aug 2025 09:51:14 -0400 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5EF6719560AA for ; Wed, 27 Aug 2025 13:51:13 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.44.22.3]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 9044918003FC for ; Wed, 27 Aug 2025 13:51:12 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-1.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1756302675; h=from:from: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: in-reply-to:in-reply-to:references:references; bh=lCrZcUpo93wopfPsT8mXqdlKPRFuPPB7h+06167eOX8=; b=NnkV1DqCnPkBldo/Tla0E9Gv+1QiWA2iOYJJxqV3A+jdQG16i2BaEq/diNAyKxNXSeiZWk +ozva+2RT3kc3KuTpOK1L7smf13l8XibqQSyfqPU0Ne+xCu4x2O1aaMacH9h4qU2H8OuMv v+y3tw9Ue8RLOKKFS8139nMYsP6fLKs= X-MC-Unique: LuECJAqVPH-oyo1FS3X5Gw-1 X-Mimecast-MFC-AGG-ID: LuECJAqVPH-oyo1FS3X5Gw_1756302673 To: devel@lists.libvirt.org Subject: [PATCH 2/4] css: Add style for '.. note:' and '.. warning:' rST roles Date: Wed, 27 Aug 2025 15:51:06 +0200 Message-ID: <19f4a435eab9b5476bb6a1356fdddec69330beb8.1756302563.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: sKlqfpCBzF8NPstz3pJZOq7Ils1UFpZrBQiVyMiZ5U0_1756302673 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: OKZ3YQY22O3YGD5D62EVM6ZTCZFUOG4Q X-Message-ID-Hash: OKZ3YQY22O3YGD5D62EVM6ZTCZFUOG4Q X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1756303345116116600 Content-Type: text/plain; charset="utf-8" From: Peter Krempa One of our kbase docs already uses '.. note:' and we could use e.g. '.. warning:' to replace some of emphasiszed paragraphs to make them more prominent. Introduce style for the generated HTML to add some hilight for them. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/css/generic.css | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/css/generic.css b/docs/css/generic.css index df37ceea37..87cd94d9f4 100644 --- a/docs/css/generic.css +++ b/docs/css/generic.css @@ -91,6 +91,32 @@ pre { padding: 1em; } +.admonition-title { + font-size: 110%; + font-weight: bold; +} + +div.admonition, +aside.admonition { + border: 1px solid #999999; +} + +.admonition p { + padding: 0 1em 0 1em; +} + +.note .admonition-title { + margin: 0; + padding: 0.5em 1em 0.5em 1em; + background: #6cb5ac; +} + +.warning .admonition-title { + margin: 0; + padding: 0.5em 1em 0.5em 1em; + background: #ffcc44; +} + a { color: rgb(0, 95, 97); } --=20 2.51.0 From nobody Sun Sep 7 23:35:47 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1756303622; cv=none; d=zohomail.com; s=zohoarc; b=LHjg5H9HLyk66vu66LVtDTZP3jcMaYeGG9YhBRJxX2uQeRs0Pb0jpBld48jSnOyC8IRIc+bAVQrLs/IIqx9QdJMydouzwlNbG1xQr+14VmR3VEkJ31xHLBtRsKqTB2e0zDBY4SR3GEjnrIhwlWbka6zLxjPPN85ePO/dWiTKljM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1756303622; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=UyL9aN2saEn8b6Dw4Rp0nQevQzDZ97PAUYuAvUfoFa0=; b=Q/G9SnNgXbqfocW+RneNoATpVWMvbNAa4f9WjEGoVR/fOUrHqJb1A/xEJiNku5s5ZKTnS2aNtZibethA5t4yFBPEKg9QmhL6ydA+Zn+VdgCewP3FNsAaZ7yQbDOYPP44vgILbCHhQmuSWo/rFTcrpnb3P+ixEb91UIVpi+C4xqY= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1756303622353713.3943633632617; Wed, 27 Aug 2025 07:07:02 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 455AB44096; Wed, 27 Aug 2025 10:07:01 -0400 (EDT) Received: from [172.19.199.3] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id A6CD143FC0; Wed, 27 Aug 2025 09:51:34 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 0D9AD44043; Wed, 27 Aug 2025 09:51:21 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 3F85A43F9D for ; Wed, 27 Aug 2025 09:51:17 -0400 (EDT) Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-308-GXh8k0HBPneo59YgMi9LiQ-1; Wed, 27 Aug 2025 09:51:15 -0400 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id B284A195419F for ; Wed, 27 Aug 2025 13:51:14 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.44.22.3]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E46F418003FC for ; Wed, 27 Aug 2025 13:51:13 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-1.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1756302676; h=from:from: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: in-reply-to:in-reply-to:references:references; bh=UyL9aN2saEn8b6Dw4Rp0nQevQzDZ97PAUYuAvUfoFa0=; b=QhwK5cFzfh/jUFFQjZ3Fi3kpcLsiVOWUBt7WfHufH5+WjwqrVn5rMJMlL3hoV3paHK3QUN OIYukHwiM7znAw/PswsGmvwRGlMLAwZOg4ObYu3WGvBVZH96s7QWGNIkEpgxbsRP09DMMy +fp1UpOHt6XEpr1Kwc+6K4Pe/VjxlzM= X-MC-Unique: GXh8k0HBPneo59YgMi9LiQ-1 X-Mimecast-MFC-AGG-ID: GXh8k0HBPneo59YgMi9LiQ_1756302674 To: devel@lists.libvirt.org Subject: [PATCH 3/4] docs: formatsecret: Convert inline emphasis of a warning to the '.. warning:' role Date: Wed, 27 Aug 2025 15:51:07 +0200 Message-ID: <24c9550442856c435d3dcb3d36a960832f60db86.1756302563.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: VWWITfybf7FNltcwPkS84HyTC8ovItZA-YCAu8vYKzc_1756302674 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: 37VS6ED44Q3SCVIUHCQ247ZC5YFLKVXI X-Message-ID-Hash: 37VS6ED44Q3SCVIUHCQ247ZC5YFLKVXI X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1756303622634116600 Content-Type: text/plain; charset="utf-8" From: Peter Krempa This is an example how to hilight very important information in the docs. Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/formatsecret.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/formatsecret.rst b/docs/formatsecret.rst index 606a9cc587..d4e0cb9ddb 100644 --- a/docs/formatsecret.rst +++ b/docs/formatsecret.rst @@ -321,9 +321,10 @@ be omitted if the file contents are base64-encoded. # virsh secret-set-value 6dd3e4a5-1d76-44ce-961f-f119f5aad935 --file se= cretinfile --plain Secret value set -**WARNING** The following approach is **insecure** and deprecated. The sec= ret -can also be set via an argument. Note that other users may see the actual = secret -in the process listing! The secret must be base64 encoded. +.. warning:: + The following approach is **insecure** and deprecated. The secret + can also be set via an argument. Note that other users may see the actu= al + secret in the process listing! The secret must be base64 encoded. :: --=20 2.51.0 From nobody Sun Sep 7 23:35:47 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1756303837; cv=none; d=zohomail.com; s=zohoarc; b=X4ZYsW+8GcKuqWq58hU/qFQlVOih0D3Cb1Ml5iUEgAhrWRqSeoqtUcaqNEiMOeVdMs0mOrtzNRV/9O66tAPjxj5wwox9qcLjoPD8VAn1dXYOQP7vZqAuH3xxsToQCUkH+rCYB6bXV3z5c53i2XSFchUv09+YxSOQYcV3lp3Qg/k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1756303837; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=weW5dLlMR3gUk3m5J+rUr1plCmTbgd6AjzoNzaA7GD8=; b=FLF3WZFJrzZL0YfV8WbJ1vswLvBIWdopJRRFFKXPEeHS1tbOna6uDtax+oClXEWTB0Gm1fEjxtHkbiwFhxsgxnHUQq/rK5IvXaf1cetweFsiVop+YLFPhAcsva7LG6ec3Lyvb3+NM2ZkmGCNUTiKXp7QVrfeSrnsrFCpEMogOT0= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 175630383751421.377278263718154; Wed, 27 Aug 2025 07:10:37 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 6C07044068; Wed, 27 Aug 2025 10:10:36 -0400 (EDT) Received: from [172.19.199.3] (lists.libvirt.org [8.43.85.245]) by lists.libvirt.org (Postfix) with ESMTP id 829504417F; Wed, 27 Aug 2025 09:51:38 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 993) id 6F3CF4405B; Wed, 27 Aug 2025 09:51:23 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (3072 bits) server-digest SHA256) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 42BCD43F8D for ; Wed, 27 Aug 2025 09:51:19 -0400 (EDT) Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-271-iLKxdzbPPdap-BBGnhYedg-1; Wed, 27 Aug 2025 09:51:16 -0400 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 009D7195608D for ; Wed, 27 Aug 2025 13:51:16 +0000 (UTC) Received: from speedmetal.redhat.com (unknown [10.44.22.3]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 3CBD118003FC for ; Wed, 27 Aug 2025 13:51:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 4.0.1 (2024-03-26) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-1.5 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_LOW, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED,RCVD_IN_VALIDITY_RPBL_BLOCKED, RCVD_IN_VALIDITY_SAFE_BLOCKED,SPF_PASS autolearn=unavailable autolearn_force=no version=4.0.1 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1756302678; h=from:from: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: in-reply-to:in-reply-to:references:references; bh=weW5dLlMR3gUk3m5J+rUr1plCmTbgd6AjzoNzaA7GD8=; b=gjS/n17rhZmeRQY9bzhYwt5qgj4Tn32tyg0pEp67zp1oTrycsupjXDHOqWLU6sBFDCAYdN eZLQNLl9LigCwH+eueWksDacKqr+UzUKEbI0iy2vKu1uRi8LGgViko9aWQUH+m9pV0WdCI DI36zNQDSLtC2dXE6VRjrx7GAjvDPlw= X-MC-Unique: iLKxdzbPPdap-BBGnhYedg-1 X-Mimecast-MFC-AGG-ID: iLKxdzbPPdap-BBGnhYedg_1756302676 To: devel@lists.libvirt.org Subject: [PATCH 4/4] kbase: live_full_disk_backup: Improve the document Date: Wed, 27 Aug 2025 15:51:08 +0200 Message-ID: <5b121a55c955ce35ddcb093e0e2dc31b3aef09fc.1756302563.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 X-Mimecast-Spam-Score: 0 X-Mimecast-MFC-PROC-ID: n_tWKQbOHsWSV61bn8wSxXt1Cty5CSk5HvfGImQZmdg_1756302676 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Message-ID-Hash: OVZYZ6RJS2KJHUF25IW4PG2EDWUCMODM X-Message-ID-Hash: OVZYZ6RJS2KJHUF25IW4PG2EDWUCMODM X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-devel.lists.libvirt.org-0; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Peter Krempa via Devel Reply-To: Peter Krempa X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1756303840323124100 Content-Type: text/plain; charset="utf-8" From: Peter Krempa Changes: - fixed emphasis on the API name and some operations - fixed the output example of some commands - added warning to avoid the snapshot+copy+commit approach as it's a bit dangerous - added --no-metadata to avoid creating snapshot XML Signed-off-by: Peter Krempa Reviewed-by: J=C3=A1n Tomko --- docs/kbase/live_full_disk_backup.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/kbase/live_full_disk_backup.rst b/docs/kbase/live_full_di= sk_backup.rst index c545aa3009..be95d9d2e2 100644 --- a/docs/kbase/live_full_disk_backup.rst +++ b/docs/kbase/live_full_disk_backup.rst @@ -13,7 +13,7 @@ that using libvirt's APIs. This method involves concepts= : the notion of `backing chains `_, `QCOW2 overlays `_, -and a special operation called "active block-commit", which allows +and a special operation called *active block-commit*, which allows live-merging an overlay disk image into its backing file. Two kinds of backup: "push" and "pull" @@ -43,7 +43,7 @@ This document covers only the full backups using the "pus= h" mode. Full disk backup using "push" mode =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -The below approach uses the modern backup API, virDomainBackupBegin(). +The below approach uses the modern backup API, ``virDomainBackupBegin()``. This requires libvirt-7.2.0 and QEMU-4.2, or higher versions. #. Start the guest:: @@ -92,8 +92,13 @@ This is the alternative in case you cannot use libvirt-7= .2.0 and QEMU-4.2 for some reason. But this assumes you're using *at least* QEMU 2.1 and libvirt-1.2.9. +.. warning:: + We strongly suggest that the backup api (``virsh backup-begin``) is used + as it doesn't require deleting files as deleting a wrong file can lead + to data loss. + This backup approach is slightly more involved, and predates the -virDomainBackupBegin() API: Assuming a guest with a single disk image, +``virDomainBackupBegin()`` API: Assuming a guest with a single disk image, create a temporary live QCOW2 overlay (commonly called as "external snapshot") to track the live guest writes. Then backup the original disk image while the guest (live QEMU) keeps writing to the temporary @@ -120,7 +125,7 @@ it. $ virsh snapshot-create-as --domain vm1 overlay1 \ --diskspec vda,file=3D/var/lib/libvirt/images/overlay1.qcow2 \ - --disk-only + --disk-only --no-metadata The disk image chain looks as follows:: @@ -141,8 +146,7 @@ it. #. Now, take a backup the original image, ``base.raw``, to a different location using ``cp`` or ``rsync``:: - $ cp /var/lib/libvirt/images/base.raw - /export/backups/copy1_base.raw + $ cp /var/lib/libvirt/images/base.raw /export/backups/copy1_base.raw # Or: @@ -156,7 +160,7 @@ it. $ virsh domblklist vm1 Target Source ------------------------------------------------ - vda vda,file=3D/var/lib/libvirt/images/overlay1.qcow2 + vda /var/lib/libvirt/images/overlay1.qcow2 #. Once the backup of the original image completes, now perform the "active block-commit" to live-merge the contents of --=20 2.51.0