[v2] A QAPI schema doc markup fix, and style cleanup

[PATCH v2 8/9] docs/interop/firmware: Literal block markup

Markus Armbruster posted 9 patches 1 week, 4 days ago

Diff against v1
Download mbox

Maintainers: "Philippe Mathieu-Daudé" <philmd@linaro.org>, "Daniel P. Berrangé" <berrange@redhat.com>, Kashyap Chamarthy <kchamart@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Stefano Garzarella <sgarzare@redhat.com>, Richard Henderson <richard.henderson@linaro.org>, Paolo Bonzini <pbonzini@redhat.com>, Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Jonathan Cameron <jonathan.cameron@huawei.com>, Fan Ni <fan.ni@samsung.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, Michael Roth <michael.roth@amd.com>, Kostiantyn Kostiuk <kkostiuk@redhat.com>

Expand all Fold all

[PATCH v2 8/9] docs/interop/firmware: Literal block markup

Posted by Markus Armbruster 1 week, 4 days ago

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>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
---
 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