[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art
From: |
Peter Maydell |
Subject: |
[PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art |
Date: |
Thu, 13 Feb 2020 17:56:24 +0000 |
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 rST
generator, which otherwise complains about the inconsistent
indentation in the ascii-art graph.
Signed-off-by: Peter Maydell <address@hidden>
---
v1->v2: tweaked commit message, made graph still line up
with preceding paragraph text
---
qapi/block-core.json | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index ef94a296868..db9ca688d49 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -550,13 +550,13 @@
# 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
##
--
2.20.1
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, (continued)
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Peter Maydell, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Peter Maydell, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Peter Maydell, 2020/02/14
- Re: [PATCH v2 01/30] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/15
[PATCH v2 02/30] configure: Check that sphinx-build is using Python 3, Peter Maydell, 2020/02/13
[PATCH v2 03/30] Makefile: Fix typo in dependency list for interop manpages, Peter Maydell, 2020/02/13
[PATCH v2 04/30] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Peter Maydell, 2020/02/13
[PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art,
Peter Maydell <=
Re: [PATCH v2 07/30] qapi/block-core.json: Use literal block for ascii art, Markus Armbruster, 2020/02/14
[PATCH v2 05/30] qga/qapi-schema.json: Fix indent level on doc comments, Peter Maydell, 2020/02/13