From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Hanna Reitz" <hreitz@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Ani Sinha" <anisinha@redhat.com>,
qemu-block@nongnu.org, "Paolo Bonzini" <pbonzini@redhat.com>,
linux-cxl@vger.kernel.org, "Jonathan Cameron" <jic23@kernel.org>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Markus Armbruster" <armbru@redhat.com>,
"Kevin Wolf" <kwolf@redhat.com>,
"Lukas Straub" <lukasstraub2@web.de>,
"Fabiano Rosas" <farosas@suse.de>,
"Eric Blake" <eblake@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Zhao Liu" <zhao1.liu@intel.com>, "Peter Xu" <peterx@redhat.com>,
"John Snow" <jsnow@redhat.com>
Subject: [PATCH 00/12] qapi: convert simple command intro sections
Date: Tue, 1 Sep 2026 15:43:12 -0400 [thread overview]
Message-ID: <20260901194324.458482-1-jsnow@redhat.com> (raw)
Hello, this work converts "simple" intro sections for command
definitions in the QAPI schema to use the new syntax. This is part of
our ongoing effort to add the mythical "inliner" to our generated QMP
documentation.
"simple" here is a non-technical distinction that means a single
paragraph of text followed by an existing section boundary that
naturally already delineates what comprises the intro.
(This is about 25% of the remaining conversions.)
If you are a non-QAPI maintainer who has been CC'd on this series,
there is likely very little for you to look at in this series. What
you need to know is that indented paragraphs become part of a
command's "intro" and will appear "above the fold" - above additional
detail in our generated QMP documentation (i.e. features, arguments,
return value, errors, etc) and anything else will eventually appear
"below the fold" - below the detail table, alongside examples, notes,
and more verbose prose.
As command definitions cannot be inlined by any other definition, the
documentation text for commands will never be re-written or reproduced
in any other context. As such, the distinction between "intro" and
"details" are less important here, but the distinction does still
determine where auto-generated documentation will be inserted, if any:
i.e. features, arguments, and return values will always be inserted
"after the intro".
John Snow (12):
qapi: convert simple command intros for ebpf.json
qapi: convert simple command intros for yank.json
qapi: convert simple command intros for replay.json
qapi: convert simple command intros for machine-s390x.json
qapi: convert simple command intros for dump.json
qapi: convert simple command intros for block-export.json
qapi: convert simple command intros for block.json
qapi: convert simple command intros for cxl.json
qapi: convert simple command intros for ui.json
qapi: convert simple command intros for migration.json
qapi: convert simple command intros for machine.json
qapi: convert simple command intros for block-core.json
qapi/block-core.json | 96 ++++++++++++++++++++---------------------
qapi/block-export.json | 18 ++++----
qapi/block.json | 8 ++--
qapi/cxl.json | 74 +++++++++++++++----------------
qapi/dump.json | 5 +--
qapi/ebpf.json | 8 ++--
qapi/machine-s390x.json | 7 ++-
qapi/machine.json | 18 ++++----
qapi/migration.json | 51 ++++++++++------------
qapi/replay.json | 39 ++++++++---------
qapi/ui.json | 11 +++--
qapi/yank.json | 5 +--
12 files changed, 157 insertions(+), 183 deletions(-)
--
2.55.0
next reply other threads:[~2026-09-01 19:43 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-01 19:43 John Snow [this message]
2026-09-01 19:43 ` [PATCH 01/12] qapi: convert simple command intros for ebpf.json John Snow
2026-09-01 19:43 ` [PATCH 02/12] qapi: convert simple command intros for yank.json John Snow
2026-09-01 19:43 ` [PATCH 03/12] qapi: convert simple command intros for replay.json John Snow
2026-09-01 19:43 ` [PATCH 04/12] qapi: convert simple command intros for machine-s390x.json John Snow
2026-09-01 19:43 ` [PATCH 05/12] qapi: convert simple command intros for dump.json John Snow
2026-09-01 19:43 ` [PATCH 06/12] qapi: convert simple command intros for block-export.json John Snow
2026-09-01 19:43 ` [PATCH 07/12] qapi: convert simple command intros for block.json John Snow
2026-09-01 19:43 ` [PATCH 08/12] qapi: convert simple command intros for cxl.json John Snow
2026-09-01 19:43 ` [PATCH 09/12] qapi: convert simple command intros for ui.json John Snow
2026-09-01 19:43 ` [PATCH 10/12] qapi: convert simple command intros for migration.json John Snow
2026-09-01 19:43 ` [PATCH 11/12] qapi: convert simple command intros for machine.json John Snow
2026-09-01 19:43 ` [PATCH 12/12] qapi: convert simple command intros for block-core.json John Snow
2026-09-03 11:58 ` Markus Armbruster
2026-09-03 11:59 ` [PATCH 00/12] qapi: convert simple command intro sections Markus Armbruster
2026-09-03 14:44 ` John Snow
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=20260901194324.458482-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=jic23@kernel.org \
--cc=kwolf@redhat.com \
--cc=linux-cxl@vger.kernel.org \
--cc=lukasstraub2@web.de \
--cc=marcandre.lureau@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@mailo.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=zhao1.liu@intel.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