Skip to content

Commit

Permalink
qapi/block-core: Tidy up BlockLatencyHistogramInfo documentation
Browse files Browse the repository at this point in the history
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]
  • Loading branch information
Markus Armbruster committed Jul 26, 2023
1 parent 6cb2011 commit dad3c95
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -652,10 +652,9 @@
# 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:
#
# ::
#
Expand Down

0 comments on commit dad3c95

Please sign in to comment.