qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, "Daniel P . Berrangé" <berrange@redhat.com>
Subject: [PULL 03/18] qapi/block-core: Fix BlockLatencyHistogramInfo doc markup
Date: Mon, 12 Feb 2024 10:14:21 +0100	[thread overview]
Message-ID: <20240212091436.688598-4-armbru@redhat.com> (raw)
In-Reply-To: <20240212091436.688598-1-armbru@redhat.com>

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 | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/qapi/block-core.json b/qapi/block-core.json
index 781c9bd03e..80ed4122f2 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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|           *
-- 
2.43.0



  parent reply	other threads:[~2024-02-12  9:16 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-12  9:14 [PULL 00/18] QAPI patches patches for 2024-02-12 Markus Armbruster
2024-02-12  9:14 ` [PULL 01/18] docs/devel/qapi-code-gen: Normalize version refs x.y.0 to just x.y Markus Armbruster
2024-02-12  9:14 ` [PULL 02/18] docs/devel/qapi-code-gen: Tweak doc comment whitespace Markus Armbruster
2024-02-12  9:14 ` Markus Armbruster [this message]
2024-02-12  9:14 ` [PULL 04/18] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-02-12  9:14 ` [PULL 05/18] sphinx/qapidoc: Drop code to generate doc for simple union tag Markus Armbruster
2024-02-12  9:14 ` [PULL 06/18] qapi: Require member documentation (with loophole) Markus Armbruster
2024-02-12  9:14 ` [PULL 07/18] qga/qapi-schema: Clean up documentation of guest-set-memory-blocks Markus Armbruster
2024-02-12  9:14 ` [PULL 08/18] qga/qapi-schema: Clean up documentation of guest-set-vcpus Markus Armbruster
2024-02-12  9:14 ` [PULL 09/18] qga/qapi-schema: Plug trivial documentation holes Markus Armbruster
2024-02-12  9:14 ` [PULL 10/18] qapi/yank: Clean up documentaion of yank Markus Armbruster
2024-02-12  9:14 ` [PULL 11/18] qapi/dump: Clean up documentation of DumpGuestMemoryCapability Markus Armbruster
2024-02-12  9:14 ` [PULL 12/18] qapi: Plug trivial documentation holes around former simple unions Markus Armbruster
2024-02-12  9:14 ` [PULL 13/18] qapi: Improve documentation of file descriptor socket addresses Markus Armbruster
2024-02-12  9:14 ` [PULL 14/18] qapi: Move @String out of common.json to discourage reuse Markus Armbruster
2024-02-12  9:14 ` [PULL 15/18] qapi: Add missing union tag documentation Markus Armbruster
2024-02-12  9:14 ` [PULL 16/18] qapi/migration: Add missing tls-authz documentation Markus Armbruster
2024-02-12  9:14 ` [PULL 17/18] MAINTAINERS: Cover qapi/cxl.json Markus Armbruster
2024-02-12  9:14 ` [PULL 18/18] MAINTAINERS: Cover qapi/stats.json Markus Armbruster
2024-02-13 13:55 ` [PULL 00/18] QAPI patches patches for 2024-02-12 Peter Maydell

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=20240212091436.688598-4-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /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).