From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: michael.roth@amd.com, eblake@redhat.com, kwolf@redhat.com,
hreitz@redhat.com, pbonzini@redhat.com,
marcandre.lureau@redhat.com, arei.gonglei@huawei.com,
pizhenwei@bytedance.com, jsnow@redhat.com,
vsementsov@yandex-team.ru, eduardo@habkost.net,
marcel.apfelbaum@gmail.com, wangyanan55@huawei.com,
quintela@redhat.com, jasowang@redhat.com,
yuval.shaia.ml@gmail.com, stefanha@redhat.com, kraxel@redhat.com,
kkostiuk@redhat.com, qemu-block@nongnu.org
Subject: [PATCH 09/16] qapi: Fix bullet list markup in documentation
Date: Tue, 4 Apr 2023 13:59:05 +0200 [thread overview]
Message-ID: <20230404115912.2829251-10-armbru@redhat.com> (raw)
In-Reply-To: <20230404115912.2829251-1-armbru@redhat.com>
Peter Maydell's commit 100cc4fe0f08 explains:
rST insists on a blank line before and after a bulleted list [...]
Add some extra blank lines in the doc comments so they're
acceptable rST input.
It missed one in qapi/trace.json.
Paolo Bonzini later added another instance in qapi/stats.json,
providing further, if unintended, evidence for his quip that rST is
the Perl of ASCII-based markups.
Both are parsed as ordinary paragraph, resulting in garbled output.
Add the blank lines we need to get the bullet lists recognized as
such.
Fixes: 100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d (qapi: Add blank lines before bulleted lists)
Fixes: 467ef823d83e (qmp: add filtering of statistics by target vCPU)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/stats.json | 1 +
qapi/trace.json | 1 +
2 files changed, 2 insertions(+)
diff --git a/qapi/stats.json b/qapi/stats.json
index 1f5d3c59ab..f17495ee65 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -107,6 +107,7 @@
# The arguments to the query-stats command; specifies a target for which to
# request statistics and optionally the required subset of information for
# that target:
+#
# - which vCPUs to request statistics for
# - which providers to request statistics from
# - which named values to return within each provider
diff --git a/qapi/trace.json b/qapi/trace.json
index 6c6982a587..f425d10764 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -87,6 +87,7 @@
# @vcpu: The vCPU to act upon (all by default; since 2.7).
#
# An event's state is modified if:
+#
# - its name matches the @name pattern, and
# - if @vcpu is given, the event has the "vcpu" property.
#
--
2.39.2
next prev parent reply other threads:[~2023-04-04 12:04 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-04 11:58 [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Markus Armbruster
2023-04-04 11:58 ` [PATCH 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status Markus Armbruster
2023-04-04 17:03 ` Konstantin Kostiuk
2023-04-04 11:58 ` [PATCH 02/16] qga/qapi-schema: Fix a misspelled reference Markus Armbruster
2023-04-04 11:58 ` [PATCH 03/16] qapi: Fix misspelled references Markus Armbruster
2023-04-05 8:21 ` David Hildenbrand
2023-04-04 11:59 ` [PATCH 04/16] qapi: Fix up references to long gone error classes Markus Armbruster
2023-04-04 11:59 ` [PATCH 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status Markus Armbruster
2023-04-11 20:56 ` John Snow
2023-04-04 11:59 ` [PATCH 06/16] qapi: @foo should be used to reference, not ``foo`` Markus Armbruster
2023-04-04 11:59 ` [PATCH 07/16] qapi: Tidy up examples Markus Armbruster
2023-04-04 11:59 ` [PATCH 08/16] qapi: Delete largely misleading "Stability Considerations" Markus Armbruster
2023-04-04 11:59 ` Markus Armbruster [this message]
2023-04-04 11:59 ` [PATCH 10/16] qapi: Fix unintended definition lists in documentation Markus Armbruster
2023-04-04 12:46 ` Peter Maydell
2023-04-04 11:59 ` [PATCH 11/16] qga/qapi-schema: Fix member documentation markup Markus Armbruster
2023-04-04 11:59 ` [PATCH 12/16] qapi: Fix argument " Markus Armbruster
2023-04-04 11:59 ` [PATCH 13/16] qapi: Replace ad hoc "since" documentation by member documentation Markus Armbruster
2023-04-04 11:59 ` [PATCH 14/16] qapi: Fix misspelled section tags in doc comments Markus Armbruster
2023-04-04 11:59 ` [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y) Markus Armbruster
2023-04-04 12:55 ` Vladimir Sementsov-Ogievskiy
2023-04-04 13:35 ` Markus Armbruster
2023-04-04 11:59 ` [PATCH 16/16] qapi storage-daemon/qapi: Fix documentation section structure Markus Armbruster
2023-04-04 13:12 ` Eric Blake
2023-04-25 4:59 ` Markus Armbruster
2023-04-04 13:19 ` zhenwei pi
2023-04-04 12:58 ` [PATCH 00/16] qapi qga/qapi-schema: Doc fixes Vladimir Sementsov-Ogievskiy
2023-04-28 9:41 ` Markus Armbruster
2023-04-04 13:06 ` Marc-André Lureau
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=20230404115912.2829251-10-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=arei.gonglei@huawei.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=hreitz@redhat.com \
--cc=jasowang@redhat.com \
--cc=jsnow@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=pbonzini@redhat.com \
--cc=pizhenwei@bytedance.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=quintela@redhat.com \
--cc=stefanha@redhat.com \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--cc=yuval.shaia.ml@gmail.com \
/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).