From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Alex Bennée" <alex.bennee@linaro.org>,
"Lukas Straub" <lukasstraub2@web.de>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Laurent Vivier" <laurent@vivier.eu>,
"Markus Armbruster" <armbru@redhat.com>,
"Gonglei (Arei)" <arei.gonglei@huawei.com>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Alex Williamson" <alex@shazbot.org>,
"zhenwei pi" <zhenwei.pi@linux.dev>,
"Hanna Reitz" <hreitz@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>,
qemu-block@nongnu.org, "Paolo Bonzini" <pbonzini@redhat.com>,
"Peter Xu" <peterx@redhat.com>, "Kevin Wolf" <kwolf@redhat.com>,
linux-cxl@vger.kernel.org, "Jiri Pirko" <jiri@resnulli.us>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
"Fabiano Rosas" <farosas@suse.de>, "John Snow" <jsnow@redhat.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Michael Tokarev" <mjt@tls.msk.ru>,
"Igor Mammedov" <imammedo@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
linux-edac@vger.kernel.org,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Richard Henderson" <richard.henderson@linaro.org>,
"Eric Blake" <eblake@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>,
"Jason Wang" <jasowangio@gmail.com>,
qemu-trivial@nongnu.org, "Jonathan Cameron" <jic23@kernel.org>
Subject: [PATCH v2 00/44] qapi: convert trivial intro sections
Date: Thu, 23 Jul 2026 00:47:21 -0400 [thread overview]
Message-ID: <20260723044805.527643-1-jsnow@redhat.com> (raw)
GitLab CI: https://gitlab.com/jsnow/qemu/-/pipelines/2699067787
Hi, this patchset converts trivial "introductory" sections in the QAPI
documentation to use the new, explicit intro section syntax.
This is being done primarily for the benefit of the forthcoming
"inliner", a feature for the rendered HTML QMP documentation that
seeks to "inline" QMP command argument documentation into the argument
list for each command.
There are two main motives here:
(1) We want the split between the "introduction" and "details"
sections to be mechanically obvious, so that auto-generated or
inlined documentation has a well-defined, obvious spot to go.
(2) We do not want to inline irrelevant, introductory text describing
structures to be copied into command documentation.
This patchset tackles "trivial" conversions: cases where the
introduction is only a single paragraph and is immediately followed by
a tagged section, the end of the documentation block, or some other
pre-existing syntactical delineation.
Future patches that may require more scrutiny will handle the
remaining conversions - I think this is enough for today, don't you?
John Snow (44):
qapi: convert intro sections for error.json
qapi: convert intro sections for acpi-hest.json
qapi: convert intro sections for ebpf.json
qapi: convert intro sections for uefi.json
qapi: convert trivial intro sections for compat.json
qapi: convert intro sections for vfio.json
qapi: convert intro sections for trace.json
qapi: convert trivial intro sections for misc-arm.json
qapi: convert intro sections for cryptodev.json
qapi: convert intro sections for machine-common.json
qapi: convert intro sections for accelerator.json
qapi: convert intro sections for authz.json
qapi: convert trivial intro sections for yank.json
qapi: convert intro sections for replay.json
qapi: convert trivial intro sections for machine-s390x.json
qapi: convert trivial intro sections for acpi.json
qapi: convert intro sections for tpm.json
qapi: convert trivial intro sections for qdev.json
qapi: convert trivial intro sections for control.json
qapi: convert intro sections for dump.json
qapi: convert intro sections for common.json
qapi: convert intro sections for sockets.json
qapi: convert trivial intro sections for transaction.json
qapi: convert trivial intro sections for stats.json
qapi: convert trivial intro sections for job.json
qapi: convert intro sections for pci.json
qapi: convert trivial intro sections for introspect.json
qapi: convert intro sections for rocker.json
qapi: convert trivial intro sections for misc-i386.json
qapi: convert trivial intro sections for block-export.json
qapi: convert intro sections for audio.json
qapi: convert trivial intro sections for block.json
qapi: convert trivial intro sections for misc.json
qapi: convert trivial intro sections for crypto.json
qapi: convert intro sections for cxl.json
qapi: convert trivial intro sections for run-state.json
qapi: convert intro sections for char.json
qapi: convert intro sections for virtio.json
qapi: convert trivial intro sections for net.json
qapi: convert trivial intro sections for qom.json
qapi: convert trivial intro sections for ui.json
qapi: convert trivial intro sections for migration.json
qapi: convert trivial intro sections for machine.json
qapi: convert trivial intro sections for block-core.json
qapi/accelerator.json | 18 +-
qapi/acpi-hest.json | 4 +-
qapi/acpi.json | 15 +-
qapi/audio.json | 88 ++----
qapi/authz.json | 21 +-
qapi/block-core.json | 646 ++++++++++++++++-----------------------
qapi/block-export.json | 87 +++---
qapi/block.json | 58 ++--
qapi/char.json | 90 ++----
qapi/common.json | 36 +--
qapi/compat.json | 6 +-
qapi/control.json | 30 +-
qapi/crypto.json | 118 +++----
qapi/cryptodev.json | 18 +-
qapi/cxl.json | 128 ++++----
qapi/dump.json | 24 +-
qapi/ebpf.json | 14 +-
qapi/error.json | 3 +-
qapi/introspect.json | 45 +--
qapi/job.json | 18 +-
qapi/machine-common.json | 19 +-
qapi/machine-s390x.json | 20 +-
qapi/machine.json | 261 ++++++----------
qapi/migration.json | 201 +++++-------
qapi/misc-arm.json | 15 +-
qapi/misc-i386.json | 52 ++--
qapi/misc.json | 74 ++---
qapi/net.json | 101 +++---
qapi/pci.json | 27 +-
qapi/qdev.json | 23 +-
qapi/qom.json | 138 +++------
qapi/replay.json | 45 ++-
qapi/rocker.json | 39 +--
qapi/run-state.json | 120 +++-----
qapi/sockets.json | 31 +-
qapi/stats.json | 34 +--
qapi/tpm.json | 29 +-
qapi/trace.json | 12 +-
qapi/transaction.json | 14 +-
qapi/uefi.json | 5 +-
qapi/ui.json | 215 +++++--------
qapi/vfio.json | 19 +-
qapi/virtio.json | 91 +++---
qapi/yank.json | 25 +-
44 files changed, 1165 insertions(+), 1912 deletions(-)
--
2.55.0
next reply other threads:[~2026-07-23 4:48 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-23 4:47 John Snow [this message]
2026-07-23 4:47 ` [PATCH v2 01/44] qapi: convert intro sections for error.json John Snow
2026-07-23 4:47 ` [PATCH v2 02/44] qapi: convert intro sections for acpi-hest.json John Snow
2026-07-23 7:29 ` Mauro Carvalho Chehab
2026-07-23 4:47 ` [PATCH v2 03/44] qapi: convert intro sections for ebpf.json John Snow
2026-07-23 4:47 ` [PATCH v2 04/44] qapi: convert intro sections for uefi.json John Snow
2026-07-23 4:47 ` [PATCH v2 05/44] qapi: convert trivial intro sections for compat.json John Snow
2026-07-23 4:47 ` [PATCH v2 06/44] qapi: convert intro sections for vfio.json John Snow
2026-07-23 4:47 ` [PATCH v2 07/44] qapi: convert intro sections for trace.json John Snow
2026-07-23 4:47 ` [PATCH v2 08/44] qapi: convert trivial intro sections for misc-arm.json John Snow
2026-07-23 4:47 ` [PATCH v2 09/44] qapi: convert intro sections for cryptodev.json John Snow
2026-07-23 9:11 ` zhenwei pi
2026-07-23 4:47 ` [PATCH v2 10/44] qapi: convert intro sections for machine-common.json John Snow
2026-07-23 4:47 ` [PATCH v2 11/44] qapi: convert intro sections for accelerator.json John Snow
2026-07-23 4:47 ` [PATCH v2 12/44] qapi: convert intro sections for authz.json John Snow
2026-07-23 4:47 ` [PATCH v2 13/44] qapi: convert trivial intro sections for yank.json John Snow
2026-07-23 4:47 ` [PATCH v2 14/44] qapi: convert intro sections for replay.json John Snow
2026-07-23 4:47 ` [PATCH v2 15/44] qapi: convert trivial intro sections for machine-s390x.json John Snow
2026-07-23 4:47 ` [PATCH v2 16/44] qapi: convert trivial intro sections for acpi.json John Snow
2026-07-23 4:47 ` [PATCH v2 17/44] qapi: convert intro sections for tpm.json John Snow
2026-07-23 4:47 ` [PATCH v2 18/44] qapi: convert trivial intro sections for qdev.json John Snow
2026-07-23 4:47 ` [PATCH v2 19/44] qapi: convert trivial intro sections for control.json John Snow
2026-07-23 4:47 ` [PATCH v2 20/44] qapi: convert intro sections for dump.json John Snow
2026-07-23 4:47 ` [PATCH v2 21/44] qapi: convert intro sections for common.json John Snow
2026-07-23 4:47 ` [PATCH v2 22/44] qapi: convert intro sections for sockets.json John Snow
2026-07-23 4:47 ` [PATCH v2 23/44] qapi: convert trivial intro sections for transaction.json John Snow
2026-07-23 4:47 ` [PATCH v2 24/44] qapi: convert trivial intro sections for stats.json John Snow
2026-07-23 4:47 ` [PATCH v2 25/44] qapi: convert trivial intro sections for job.json John Snow
2026-07-23 4:47 ` [PATCH v2 26/44] qapi: convert intro sections for pci.json John Snow
2026-07-23 4:47 ` [PATCH v2 27/44] qapi: convert trivial intro sections for introspect.json John Snow
2026-07-23 4:47 ` [PATCH v2 28/44] qapi: convert intro sections for rocker.json John Snow
2026-07-23 4:47 ` [PATCH v2 29/44] qapi: convert trivial intro sections for misc-i386.json John Snow
2026-07-23 4:47 ` [PATCH v2 30/44] qapi: convert trivial intro sections for block-export.json John Snow
2026-07-23 4:47 ` [PATCH v2 31/44] qapi: convert intro sections for audio.json John Snow
2026-07-23 4:47 ` [PATCH v2 32/44] qapi: convert trivial intro sections for block.json John Snow
2026-07-23 4:47 ` [PATCH v2 33/44] qapi: convert trivial intro sections for misc.json John Snow
2026-07-23 4:47 ` [PATCH v2 34/44] qapi: convert trivial intro sections for crypto.json John Snow
2026-07-23 4:47 ` [PATCH v2 35/44] qapi: convert intro sections for cxl.json John Snow
2026-07-23 4:47 ` [PATCH v2 36/44] qapi: convert trivial intro sections for run-state.json John Snow
2026-07-23 4:47 ` [PATCH v2 37/44] qapi: convert intro sections for char.json John Snow
2026-07-23 4:47 ` [PATCH v2 38/44] qapi: convert intro sections for virtio.json John Snow
2026-07-23 4:48 ` [PATCH v2 39/44] qapi: convert trivial intro sections for net.json John Snow
2026-07-23 4:48 ` [PATCH v2 40/44] qapi: convert trivial intro sections for qom.json John Snow
2026-07-23 4:48 ` [PATCH v2 41/44] qapi: convert trivial intro sections for ui.json John Snow
2026-07-23 4:48 ` [PATCH v2 42/44] qapi: convert trivial intro sections for migration.json John Snow
2026-07-23 4:48 ` [PATCH v2 43/44] qapi: convert trivial intro sections for machine.json John Snow
2026-07-23 4:48 ` [PATCH v2 44/44] qapi: convert trivial intro sections for block-core.json 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=20260723044805.527643-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=alex@shazbot.org \
--cc=anisinha@redhat.com \
--cc=arei.gonglei@huawei.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=clg@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowangio@gmail.com \
--cc=jic23@kernel.org \
--cc=jiri@resnulli.us \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=laurent@vivier.eu \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-edac@vger.kernel.org \
--cc=lukasstraub2@web.de \
--cc=marcandre.lureau@redhat.com \
--cc=mchehab+huawei@kernel.org \
--cc=mjt@tls.msk.ru \
--cc=mst@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=qemu-trivial@nongnu.org \
--cc=richard.henderson@linaro.org \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stefanha@redhat.com \
--cc=vsementsov@yandex-team.ru \
--cc=zhao1.liu@intel.com \
--cc=zhenwei.pi@linux.dev \
/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