qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com,
	Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Subject: [PATCH 1/6] qapi/block-core: Tidy up BlockLatencyHistogramInfo documentation
Date: Thu, 20 Jul 2023 09:16:04 +0200	[thread overview]
Message-ID: <20230720071610.1096458-2-armbru@redhat.com> (raw)
In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com>

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,
    same number of elements as "boundaries".  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>
---
 qapi/block-core.json | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 5dd5f7e4b0..6ca448b6e6 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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, same number of elements as @boundaries.  For the
+#     example above, @bins may be something like [3, 1, 5, 2], and
+#     corresponding histogram looks like:
 #
 # ::
 #
-- 
2.41.0



  reply	other threads:[~2023-07-20  7:18 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-07-20  7:16 [PATCH 0/6] qapi: Tidy up doc comments Markus Armbruster
2023-07-20  7:16 ` Markus Armbruster [this message]
2023-07-20  7:16 ` [PATCH 2/6] qapi/block: Tidy up block-latency-histogram-set documentation Markus Armbruster
2023-07-20 13:39   ` Philippe Mathieu-Daudé
2023-07-20  7:16 ` [PATCH 3/6] qapi/qdev: Tidy up device_add documentation Markus Armbruster
2023-07-20 13:42   ` Philippe Mathieu-Daudé
2023-07-20  7:16 ` [PATCH 4/6] qapi/trace: Tidy up trace-event-get-state, -set-state documentation Markus Armbruster
2023-07-20  7:16 ` [PATCH 5/6] qapi: Correct "eg." to "e.g." in documentation Markus Armbruster
2023-07-20 13:41   ` Philippe Mathieu-Daudé
2023-07-20 15:13     ` Markus Armbruster
2023-07-20  7:16 ` [PATCH 6/6] qapi: Reformat recent doc comments to conform to current conventions Markus Armbruster

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230720071610.1096458-2-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=eblake@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=vsementsov@yandex-team.ru \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).