]> git.proxmox.com Git - mirror_qemu.git/commitdiff
qapi/block-core.json: Use literal block for ascii art
authorPeter Maydell <peter.maydell@linaro.org>
Thu, 13 Feb 2020 17:56:24 +0000 (17:56 +0000)
committerMarkus Armbruster <armbru@redhat.com>
Sat, 15 Feb 2020 10:41:49 +0000 (11:41 +0100)
The ascii-art graph in the BlockLatencyHistogramInfo documentation
doesn't render correctly, because the whitespace is collapsed.

Use the '|' format that emits a literal 'example' block so the graph
is displayed correctly.

Strictly the Texinfo generated is still wrong because each line
goes into its own @example environment, but it renders better
than what we had before.

Fixing this rendering is a necessary prerequisite for the upcoming rST
generator, which otherwise complains about the inconsistent
indentation in the ascii-art graph.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200213175647.17628-8-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
qapi/block-core.json

index ef94a296868fae0b23ad9a0619700b59a0227412..db9ca688d49a157b5260b21e2fcc3d609239de51 100644 (file)
 #        For the example above, @bins may be something like [3, 1, 5, 2],
 #        and corresponding histogram looks like:
 #
-#        5|           *
-#        4|           *
-#        3| *         *
-#        2| *         *    *
-#        1| *    *    *    *
-#         +------------------
-#             10   50   100
+# |      5|           *
+# |      4|           *
+# |      3| *         *
+# |      2| *         *    *
+# |      1| *    *    *    *
+# |       +------------------
+# |           10   50   100
 #
 # Since: 4.0
 ##