diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-02-05 08:46:57 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-02-12 10:04:31 +0100 |
| commit | d9884878820366e66d3e28436daf5aa3d0fb9c37 (patch) | |
| tree | 8fa6abbad904a06f0488d499523c9460e195a767 /qapi/block-core.json | |
| parent | 399c8cd3ba9215f8e4ea166dce0f6619071a4f66 (diff) | |
qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
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>
Message-ID: <20240205074709.3613229-4-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Diffstat (limited to 'qapi/block-core.json')
| -rw-r--r-- | qapi/block-core.json | 4 |
1 files changed, 1 insertions, 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| * |