Skip to content

Commit

Permalink
qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
Browse files Browse the repository at this point in the history
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 a0fcff3 (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>
  • Loading branch information
Markus Armbruster committed Feb 12, 2024
1 parent 399c8cd commit d988487
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -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| *
Expand Down

0 comments on commit d988487

Please sign in to comment.