From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Hanna Reitz" <hreitz@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Kevin Wolf" <kwolf@redhat.com>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Jason Wang" <jasowangio@gmail.com>,
"Eric Blake" <eblake@redhat.com>,
qemu-block@nongnu.org, "Igor Mammedov" <imammedo@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"John Snow" <jsnow@redhat.com>, "Peter Xu" <peterx@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@oss.qualcomm.com>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: [PATCH v2 00/10] qapi: convert/split remaining QAPI/QMP intro sections
Date: Mon, 21 Sep 2026 16:57:02 -0400 [thread overview]
Message-ID: <20260921205712.1862167-1-jsnow@redhat.com> (raw)
Depending on what order you read these in, this series is either the
second-to-last batch or the very last batch.
This series covers the trickiest bits of qapi/qapi-schema.json, ones
that involve multiple paragraphs and decisions over where exactly to
place the split. Currently there are only some very minor prose
rewrites the break apart intro statements from paragraphs where deemed
appropriate.
If you are a non-QAPI maintainer, the TL:DR here is:
Take a look at what is being indented here and what is
not. Anything that gets indented is text that is not eligible for
inlining: that is, the intro text is not copied into command/event
documentation to replace "The members of ..." placeholders in our
generated documentation.
If any text that you believe is important for end users to
understand is in the indented section after these patches, please
review and propose a different prose split.
(More info: The intro text is not guaranteed to be dropped from
generated docs. For example, if a struct is used as a type for an
argument in its own right, it is guaranteed to be included in the
generated documentation. It is also always included for commands,
events, and enums. It is only for structs which are *only* ever
used as command/event arguments or as a branch type where this
text is at risk of not being reproduced at all in the output
documentation.)
John Snow (10):
qapi: split intro for HV_BALLOON_STATUS_REPORT
qapi: convert/split intros for block-core.json commands
qapi: convert/split intros for block commands
qapi: convert/split intros for job.json commands
qapi: convert/split intros for misc-i386.json commands
qapi: convert/split intros for commands
qapi: convert/split intros for enums
qapi: split intro sections for events
qapi: split intro sections for data structs
qapi: split intro sections for inlinable structs
qapi/acpi.json | 3 +-
qapi/block-core.json | 131 +++++++++++++++++-----------------------
qapi/block-export.json | 8 +--
qapi/block.json | 33 +++++-----
qapi/compat.json | 3 +-
qapi/control.json | 3 +-
qapi/crypto.json | 3 +-
qapi/introspect.json | 16 ++---
qapi/job.json | 42 ++++++-------
qapi/machine-s390x.json | 3 +-
qapi/machine.json | 78 +++++++++++-------------
qapi/migration.json | 12 ++--
qapi/misc-arm.json | 5 +-
qapi/misc-i386.json | 22 +++----
qapi/misc.json | 8 +--
qapi/net.json | 37 +++++-------
qapi/qdev.json | 9 ++-
qapi/qom.json | 9 +--
qapi/stats.json | 5 +-
qapi/transaction.json | 6 +-
qapi/ui.json | 8 +--
21 files changed, 192 insertions(+), 252 deletions(-)
--
2.55.0
next reply other threads:[~2026-09-21 20:57 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-21 20:57 John Snow [this message]
2026-09-21 20:57 ` [PATCH v2 02/10] qapi: convert/split intros for block-core.json commands John Snow
2026-09-23 8:50 ` Markus Armbruster
2026-09-25 17:15 ` John Snow
2026-09-26 5:57 ` Markus Armbruster
2026-09-21 20:57 ` [PATCH v2 04/10] qapi: convert/split intros for job.json commands John Snow
2026-09-23 9:20 ` Markus Armbruster
2026-09-23 19:35 ` John Snow
2026-09-21 20:57 ` [PATCH v2 06/10] qapi: convert/split intros for commands John Snow
2026-09-23 11:06 ` Markus Armbruster
2026-09-21 20:57 ` [PATCH v2 09/10] qapi: split intro sections for data structs John Snow
2026-09-23 10:48 ` Markus Armbruster
2026-09-23 21:17 ` John Snow
2026-09-21 20:57 ` [PATCH v2 10/10] qapi: split intro sections for inlinable structs John Snow
2026-09-23 9:59 ` Markus Armbruster
[not found] ` <20260921205712.1862167-4-jsnow@redhat.com>
2026-09-23 9:17 ` [PATCH v2 03/10] qapi: convert/split intros for block commands Markus Armbruster
2026-09-28 14:32 ` Eric Blake
2026-09-28 18:00 ` John Snow
[not found] ` <20260921205712.1862167-6-jsnow@redhat.com>
2026-09-23 9:21 ` [PATCH v2 05/10] qapi: convert/split intros for misc-i386.json commands Markus Armbruster
-- strict thread matches above, loose matches on Subject: below --
2026-09-21 20:54 [PATCH v2 00/10] qapi: convert/split remaining QAPI/QMP intro sections 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=20260921205712.1862167-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowangio@gmail.com \
--cc=kwolf@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@mailo.com \
--cc=philmd@oss.qualcomm.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.