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

Markus Armbruster posted 8 patches 2 weeks ago
There is a newer version of this series
[PATCH 7/8] docs/interop/firmware: Literal block markup
Posted by Markus Armbruster 2 weeks 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>
---
 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
Re: [PATCH 7/8] docs/interop/firmware: Literal block markup
Posted by Vladimir Sementsov-Ogievskiy 2 weeks ago
On 31.10.25 12:47, Markus Armbruster wrote:
> 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: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

-- 
Best regards,
Vladimir
Re: [PATCH 7/8] docs/interop/firmware: Literal block markup
Posted by Philippe Mathieu-Daudé 2 weeks ago
On 31/10/25 10:47, Markus Armbruster wrote:
> 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(+)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>