From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: jsnow@redhat.com, eblake@redhat.com, vsementsov@yandex-team.ru,
thuth@redhat.com, berrange@redhat.com, philmd@linaro.org,
kchamart@redhat.com, mst@redhat.com, sgarzare@redhat.com
Subject: [PATCH 7/8] docs/interop/firmware: Literal block markup
Date: Fri, 31 Oct 2025 10:47:50 +0100 [thread overview]
Message-ID: <20251031094751.2817932-8-armbru@redhat.com> (raw)
In-Reply-To: <20251031094751.2817932-1-armbru@redhat.com>
A few doc comments show command line snippets. The snippets are
indented, which is legible enough. Actually formatting these with
Sphinx would fail with "Unexpected indentation", though. We don't so
far. Add suitable markup anyway.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
docs/interop/firmware.json | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json
index 7ffa7697e4..da0362a2c0 100644
--- a/docs/interop/firmware.json
+++ b/docs/interop/firmware.json
@@ -308,12 +308,19 @@
# indicates whether there will be an associated NVRAM template
# present. The preferred corresponding QEMU command line options
# are
+#
+# ::
+#
# -drive if=none,id=pflash0,readonly=on,file=@executable.@filename,format=@executable.@format
# -machine pflash0=pflash0
+#
# or equivalent -blockdev instead of -drive. When @mode is
# @combined the executable must be cloned before use and
# configured with readonly=off. With QEMU versions older than
# 4.0, you have to use
+#
+# ::
+#
# -drive if=pflash,unit=0,readonly=on,file=@executable.@filename,format=@executable.@format
#
# @nvram-template: Identifies the NVRAM template compatible with
@@ -326,10 +333,17 @@
# typically used for persistently storing the non-volatile UEFI
# variables of a virtual machine definition. The preferred
# corresponding QEMU command line options are
+#
+# ::
+#
# -drive if=none,id=pflash1,readonly=off,file=FILENAME_OF_PRIVATE_NVRAM_FILE,format=@nvram-template.@format
# -machine pflash1=pflash1
+#
# or equivalent -blockdev instead of -drive. With QEMU versions
# older than 4.0, you have to use
+#
+# ::
+#
# -drive if=pflash,unit=1,readonly=off,file=FILENAME_OF_PRIVATE_NVRAM_FILE,format=@nvram-template.@format
#
# Since: 3.0
--
2.49.0
next prev parent reply other threads:[~2025-10-31 9:48 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-31 9:47 [PATCH 0/8] A QAPI schema doc markup fix, and style cleanup Markus Armbruster
2025-10-31 9:47 ` [PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples Markus Armbruster
2025-10-31 9:53 ` Vladimir Sementsov-Ogievskiy
2025-10-31 11:46 ` Markus Armbruster
2025-10-31 10:02 ` Philippe Mathieu-Daudé
2025-10-31 9:47 ` [PATCH 2/8] qapi: Refill doc comments to conform to conventions Markus Armbruster
2025-10-31 10:25 ` Vladimir Sementsov-Ogievskiy
2025-10-31 11:47 ` Markus Armbruster
2025-10-31 9:47 ` [PATCH 3/8] qapi: Clean up whitespace between definitions Markus Armbruster
2025-10-31 10:02 ` Philippe Mathieu-Daudé
2025-10-31 10:26 ` Vladimir Sementsov-Ogievskiy
2025-10-31 9:47 ` [PATCH 4/8] qga/qapi-schema: Refill doc comments to conform to conventions Markus Armbruster
2025-10-31 10:28 ` Vladimir Sementsov-Ogievskiy
2025-10-31 9:47 ` [PATCH 5/8] qga/qapi-schema: Clean up whitespace between definitions Markus Armbruster
2025-10-31 10:02 ` Philippe Mathieu-Daudé
2025-10-31 10:28 ` Vladimir Sementsov-Ogievskiy
2025-10-31 9:47 ` [PATCH 6/8] docs/interop: Refill QAPI doc comments to conform to conventions Markus Armbruster
2025-10-31 10:32 ` Vladimir Sementsov-Ogievskiy
2025-10-31 11:41 ` Markus Armbruster
2025-10-31 9:47 ` Markus Armbruster [this message]
2025-10-31 10:03 ` [PATCH 7/8] docs/interop/firmware: Literal block markup Philippe Mathieu-Daudé
2025-10-31 10:36 ` Vladimir Sementsov-Ogievskiy
2025-10-31 9:47 ` [PATCH 8/8] docs/interop: Add test to keep vhost-user.json sane Markus Armbruster
2025-10-31 10:53 ` Vladimir Sementsov-Ogievskiy
2025-10-31 11:45 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251031094751.2817932-8-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=jsnow@redhat.com \
--cc=kchamart@redhat.com \
--cc=mst@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=sgarzare@redhat.com \
--cc=thuth@redhat.com \
--cc=vsementsov@yandex-team.ru \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).