]> xenbits.xensource.com Git - qemu-xen.git/commitdiff
qapi/block-core: Tidy up BlockLatencyHistogramInfo documentation
authorMarkus Armbruster <armbru@redhat.com>
Thu, 20 Jul 2023 07:16:04 +0000 (09:16 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 26 Jul 2023 12:50:16 +0000 (14:50 +0200)
Documentation for member @bin comes out like

    list of io request counts corresponding to histogram intervals.
    len("bins") = len("boundaries") + 1 For the example above, "bins"
    may be something like [3, 1, 5, 2], and corresponding histogram
    looks like:

Note how the equation and the sentence following it run together.
Replace the equation:

    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:

Cc: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20230720071610.1096458-2-armbru@redhat.com>
[Off by one fixed]

qapi/block-core.json

index 5dd5f7e4b0ba094b68e2cae2470e4579f4e6f3b7..dcfd54d15ce95d9e82c00c51db1a35136db8ad1c 100644 (file)
 #     10), [10, 50), [50, 100), [100, +inf).
 #
 # @bins: list of io request counts corresponding to histogram
-#     intervals.
-#     len(@bins) = len(@boundaries) + 1
-#     For the example above, @bins may be something like [3, 1, 5, 2],
-#     and corresponding histogram looks like:
+#     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:
 #
 # ::
 #