[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 09/18] qapi/block-core.json: Use literal block for ascii art
From: |
Markus Armbruster |
Subject: |
[PULL 09/18] qapi/block-core.json: Use literal block for ascii art |
Date: |
Sat, 15 Feb 2020 12:41:24 +0100 |
From: Peter Maydell <address@hidden>
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 <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <address@hidden>
---
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 ef94a29686..db9ca688d4 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.21.1
- [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, (continued)
- [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Markus Armbruster, 2020/02/15
- [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments, Markus Armbruster, 2020/02/15
- [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages, Markus Armbruster, 2020/02/15
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place, Markus Armbruster, 2020/02/15
- [PULL 03/18] configure: Pick sphinx-build-3 when available, Markus Armbruster, 2020/02/15
- [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes, Markus Armbruster, 2020/02/15
- [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation, Markus Armbruster, 2020/02/15
- [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting, Markus Armbruster, 2020/02/15
- [PULL 02/18] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/15
- [PULL 16/18] qapi: Add blank lines before bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 09/18] qapi/block-core.json: Use literal block for ascii art,
Markus Armbruster <=
- [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST, Markus Armbruster, 2020/02/15
- [PULL 15/18] qapi: Use explicit bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 17/18] qapi/migration.json: Replace _this_ with *this*, Markus Armbruster, 2020/02/15
- [PULL 12/18] qapi: Remove hardcoded tabs, Markus Armbruster, 2020/02/15
- [PULL 04/18] configure: Check that sphinx-build is using Python 3, Markus Armbruster, 2020/02/15
- [PULL 11/18] qapi: Fix indent level on doc comments in json files, Markus Armbruster, 2020/02/15
- Re: [PULL 00/18] QAPI patches for 2020-02-15, Peter Maydell, 2020/02/17