[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 03/15] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
From: |
Markus Armbruster |
Subject: |
[PATCH 03/15] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup |
Date: |
Mon, 5 Feb 2024 08:46:57 +0100 |
The description of @bins ends with a literal block:
# @bins: list of io request counts corresponding to histogram
# intervals, one more element than @boundaries has. For the
# example above, @bins may be something like [3, 1, 5, 2], and
# corresponding histogram looks like:
#
# ::
#
# 5| *
Except it actually ends *before* the block: the unindented '::' line
starts a new section. Makes no sense.
We could fix this by indenting the '::' line. Instead, double the
colon at the end of the preceding paragraph, and drop the '::' line.
This shifts the box for the literal block right in generated
documentation, so it lines up with the description.
Fixes: commit a0fcff383b34 (qapi: Use rST markup for literal blocks)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 781c9bd03e..80ed4122f2 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -656,9 +656,7 @@
# @bins: list of io request counts corresponding to histogram
# intervals, one more element than @boundaries has. For the
# example above, @bins may be something like [3, 1, 5, 2], and
-# corresponding histogram looks like:
-#
-# ::
+# corresponding histogram looks like::
#
# 5| *
# 4| *
--
2.43.0
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, (continued)
- [PATCH 12/15] qapi: Plug trivial documentation holes around former simple unions, Markus Armbruster, 2024/02/05
- [PATCH 14/15] qapi: Move @String out of common.json to discourage reuse, Markus Armbruster, 2024/02/05
- [PATCH 13/15] qapi: Improve documentation of file descriptor socket addresses, Markus Armbruster, 2024/02/05
- [PATCH 02/15] docs/devel/qapi-code-gen: Tweak doc comment whitespace, Markus Armbruster, 2024/02/05
- [PATCH 01/15] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y, Markus Armbruster, 2024/02/05
- [PATCH 03/15] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup,
Markus Armbruster <=
- [PATCH 15/15] qapi: Add missing union tag documentation, Markus Armbruster, 2024/02/05
- [PATCH 04/15] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/02/05
- [PATCH 11/15] qapi/dump: Clean up documentation of DumpGuestMemoryCapability, Markus Armbruster, 2024/02/05
- [PATCH 10/15] qapi/yank: Clean up documentaion of yank, Markus Armbruster, 2024/02/05
- [PATCH 08/15] qga/qapi-schema: Clean up documentation of guest-set-vcpus, Markus Armbruster, 2024/02/05