]> www.infradead.org Git - users/dwmw2/qemu.git/commitdiff
qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
authorMarkus Armbruster <armbru@redhat.com>
Mon, 5 Feb 2024 07:46:57 +0000 (08:46 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 12 Feb 2024 09:04:31 +0000 (10:04 +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>
Message-ID: <20240205074709.3613229-4-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
qapi/block-core.json

index 781c9bd03e8889d042404d72bcbb150d4d4f0457..80ed4122f29d885edb1dd81d104724b50057b404 100644 (file)
 # @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|           *