From nobody Mon Dec 15 21:26:25 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1559598743; cv=none; d=zoho.com; s=zohoarc; b=SkGIGNWtedmqBbinEj5q2m6jwWrakmN81W1RDlF39zjt1Dz71oK2TvZxR4OndzDPkE/9FrN/U8lNBVeTOwE2nRAY9LmGUXYHfGq8WJBOrEa4LttMTTLFTLBN2Q87hueu8C49OGT90aKjzAMAAdgepTnFnjBn5NTnUYHtD6TFyFU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1559598743; h=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:ARC-Authentication-Results; bh=N6gTqUvlLGO+WPQ7L0fNQ/sfGcroVszIOAgO+2jWOro=; b=CxoQon6aRe9dtQnaW7V0hR9H83dvrLNdCWGvaH13qX4dlkHQlwfMcp2Ngmvf0sEIpqYTbIup1tduuCmMd/Tm4Iuon98M9p8y++0ATwHteKF3iCv8Aia41Afn4mbjt6uI0Du/vR9E6Bzr+BBXVnyz815nnrqEggv2n3TWpPOnJ8w= ARC-Authentication-Results: i=1; mx.zoho.com; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1559598743489740.4393393027327; Mon, 3 Jun 2019 14:52:23 -0700 (PDT) Received: from localhost ([127.0.0.1]:41355 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hXusP-0002zt-Gy for importer@patchew.org; Mon, 03 Jun 2019 17:52:21 -0400 Received: from eggs.gnu.org ([209.51.188.92]:39736) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hXuni-0008F4-Pe for qemu-devel@nongnu.org; Mon, 03 Jun 2019 17:47:37 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hXunb-0003Cs-G3 for qemu-devel@nongnu.org; Mon, 03 Jun 2019 17:47:30 -0400 Received: from mx1.redhat.com ([209.132.183.28]:52224) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hXunR-0002XA-8w; Mon, 03 Jun 2019 17:47:13 -0400 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.phx2.redhat.com [10.5.11.16]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 3161530C31A1; Mon, 3 Jun 2019 21:47:06 +0000 (UTC) Received: from probe.bos.redhat.com (dhcp-17-164.bos.redhat.com [10.18.17.164]) by smtp.corp.redhat.com (Postfix) with ESMTP id 67FFD17278; Mon, 3 Jun 2019 21:47:04 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org, qemu-block@nongnu.org Date: Mon, 3 Jun 2019 17:46:53 -0400 Message-Id: <20190603214653.29369-4-jsnow@redhat.com> In-Reply-To: <20190603214653.29369-1-jsnow@redhat.com> References: <20190603214653.29369-1-jsnow@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.16 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.40]); Mon, 03 Jun 2019 21:47:07 +0000 (UTC) Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.132.183.28 Subject: [Qemu-devel] [PATCH v3 3/3] docs/bitmaps: use QMP lexer instead of json X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Fam Zheng , Peter Maydell , John Snow , Aarushi Mehta , Eduardo Habkost Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" Content-Type: text/plain; charset="utf-8" The annotated style json we use in QMP documentation is not strict json and depending on the version of Sphinx (2.0+) or Pygments installed, might cause the build to fail. Use the new QMP lexer. Further, some versions of Sphinx can not apply custom lexers to "code" directives and require the use of "code-block" directives instead, so make that change at this time as well. Tested under: - Sphinx 1.3.6 and Pygments 2.4 - Sphinx 1.7.6 and Pygments 2.2 (Fedora 29 packages) - Sphinx 2.0.1 and Pygments 2.4 - Sphinx 3.0.0+/f396b3a783 and Pygments 2.4 (From Sphinx git c4f44bdd) Reported-by: Aarushi Mehta Signed-off-by: John Snow Reviewed-by: Eduardo Habkost --- docs/interop/bitmaps.rst | 54 ++++++++++++++++++++-------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst index c29ac4a854..c20bd37a79 100644 --- a/docs/interop/bitmaps.rst +++ b/docs/interop/bitmaps.rst @@ -199,7 +199,7 @@ persistence, and recording state can be adjusted at cre= ation time. =20 to create a new, actively recording persistent bitmap: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-add", "arguments": { @@ -220,7 +220,7 @@ persistence, and recording state can be adjusted at cre= ation time. To create a new, disabled (``-recording``), transient bitmap that tracks changes in 32KiB segments: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-add", "arguments": { @@ -254,7 +254,7 @@ Deletes a bitmap. Bitmaps that are ``+busy`` cannot be = removed. =20 Remove a bitmap named ``bitmap0`` from node ``drive0``: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-remove", "arguments": { @@ -280,7 +280,7 @@ Clears all dirty bits from a bitmap. ``+busy`` bitmaps = cannot be cleared. =20 Clear all dirty bits from bitmap ``bitmap0`` on node ``drive0``: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-clear", "arguments": { @@ -309,7 +309,7 @@ begin being recorded. ``+busy`` bitmaps cannot be enabl= ed. =20 To set ``+recording`` on bitmap ``bitmap0`` on node ``drive0``: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-enable", "arguments": { @@ -347,7 +347,7 @@ writes to begin being ignored. ``+busy`` bitmaps cannot= be disabled. =20 To set ``-recording`` on bitmap ``bitmap0`` on node ``drive0``: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-disable", "arguments": { @@ -393,7 +393,7 @@ in any one source bitmap, the target bitmap will mark t= hat segment dirty. ``drive0``. If ``new_bitmap`` was empty prior to this command, this achie= ves a copy. =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "block-dirty-bitmap-merge", "arguments": { @@ -424,7 +424,7 @@ attached to nodes serving as the root for guest devices. API. This result highlights a bitmap ``bitmap0`` attached to the root nod= e of device ``drive0``. =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "query-block", @@ -562,7 +562,7 @@ new, empty bitmap that records writes from this point i= n time forward. destination. These writes will be recorded in the bitmap accordingly. =20 -.. code:: json +.. code-block:: QMP =20 -> { "execute": "transaction", @@ -650,7 +650,7 @@ Example: Resetting an Incremental Backup Anchor Point If we want to start a new backup chain with an existing bitmap, we can also use a transaction to reset the bitmap while making a new full backup: =20 -.. code:: json +.. code-block:: QMP =20 -> { "execute": "transaction", @@ -730,7 +730,7 @@ Example: First Incremental Backup =20 #. Issue an incremental backup command: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "drive-backup", @@ -788,7 +788,7 @@ Example: Second Incremental Backup #. Issue a new incremental backup command. The only difference here is tha= t we have changed the target image below. =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "drive-backup", @@ -869,7 +869,7 @@ image: #. Issue a new incremental backup command. Apart from the new destination image, there is no difference from the last two examples. =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "drive-backup", @@ -932,7 +932,7 @@ point in time. =20 #. Create a full (anchor) backup for each drive, with accompanying bitmaps: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "transaction", @@ -1018,7 +1018,7 @@ point in time. =20 #. Issue a multi-drive incremental push backup transaction: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "transaction", @@ -1121,7 +1121,7 @@ described above. This example demonstrates the single= -job failure case: =20 #. Attempt to create an incremental backup via QMP: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "drive-backup", @@ -1139,7 +1139,7 @@ described above. This example demonstrates the single= -job failure case: =20 #. Receive a pair of events indicating failure: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, @@ -1175,7 +1175,7 @@ described above. This example demonstrates the single= -job failure case: #. Retry the command after fixing the underlying problem, such as freeing up space on the backup volume: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "drive-backup", @@ -1193,7 +1193,7 @@ described above. This example demonstrates the single= -job failure case: =20 #. Receive confirmation that the job completed successfully: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, @@ -1233,7 +1233,7 @@ and one succeeds: =20 #. Issue the transaction to start a backup of both drives. =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "transaction", @@ -1267,13 +1267,13 @@ and one succeeds: #. Receive notice that the Transaction was accepted, and jobs were launched: =20 - .. code:: json + .. code-block:: QMP =20 <- { "return": {} } =20 #. Receive notice that the first job has completed: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, @@ -1289,7 +1289,7 @@ and one succeeds: =20 #. Receive notice that the second job has failed: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, @@ -1365,7 +1365,7 @@ applied: =20 #. Issue the multi-drive incremental backup transaction: =20 - .. code:: json + .. code-block:: QMP =20 -> { "execute": "transaction", @@ -1401,13 +1401,13 @@ applied: =20 #. Receive notice that the Transaction was accepted, and jobs were launche= d: =20 - .. code:: json + .. code-block:: QMP =20 <- { "return": {} } =20 #. Receive notification that the backup job for ``drive1`` has failed: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, @@ -1434,7 +1434,7 @@ applied: =20 #. Receive notification that the job for ``drive0`` has been cancelled: =20 - .. code:: json + .. code-block:: QMP =20 <- { "timestamp": {...}, --=20 2.20.1