[PATCH v2 00/44] qapi: convert trivial intro sections
John Snow <[email protected]> Thu, 23 Jul 2026 00:47:21 -0400
| Newsgroups | org.nongnu.qemu-trivial,org.kernel.vger.linux-cxl,org.kernel.vger.linux-edac,org.nongnu.qemu-devel |
|---|---|
| Message-ID | <[email protected]> |
GitLab CI: https://gitlab.com/jsnow/qemu/-/pipelines/2699067787=0D
=0D
Hi, this patchset converts trivial "introductory" sections in the QAPI=0D
documentation to use the new, explicit intro section syntax.=0D
=0D
This is being done primarily for the benefit of the forthcoming=0D
"inliner", a feature for the rendered HTML QMP documentation that=0D
seeks to "inline" QMP command argument documentation into the argument=0D
list for each command.=0D
=0D
There are two main motives here:=0D
=0D
(1) We want the split between the "introduction" and "details"=0D
sections to be mechanically obvious, so that auto-generated or=0D
inlined documentation has a well-defined, obvious spot to go.=0D
=0D
(2) We do not want to inline irrelevant, introductory text describing=0D
structures to be copied into command documentation.=0D
=0D
This patchset tackles "trivial" conversions: cases where the=0D
introduction is only a single paragraph and is immediately followed by=0D
a tagged section, the end of the documentation block, or some other=0D
pre-existing syntactical delineation.=0D
=0D
Future patches that may require more scrutiny will handle the=0D
remaining conversions - I think this is enough for today, don't you?=0D
=0D
John Snow (44):=0D
qapi: convert intro sections for error.json=0D
qapi: convert intro sections for acpi-hest.json=0D
qapi: convert intro sections for ebpf.json=0D
qapi: convert intro sections for uefi.json=0D
qapi: convert trivial intro sections for compat.json=0D
qapi: convert intro sections for vfio.json=0D
qapi: convert intro sections for trace.json=0D
qapi: convert trivial intro sections for misc-arm.json=0D
qapi: convert intro sections for cryptodev.json=0D
qapi: convert intro sections for machine-common.json=0D
qapi: convert intro sections for accelerator.json=0D
qapi: convert intro sections for authz.json=0D
qapi: convert trivial intro sections for yank.json=0D
qapi: convert intro sections for replay.json=0D
qapi: convert trivial intro sections for machine-s390x.json=0D
qapi: convert trivial intro sections for acpi.json=0D
qapi: convert intro sections for tpm.json=0D
qapi: convert trivial intro sections for qdev.json=0D
qapi: convert trivial intro sections for control.json=0D
qapi: convert intro sections for dump.json=0D
qapi: convert intro sections for common.json=0D
qapi: convert intro sections for sockets.json=0D
qapi: convert trivial intro sections for transaction.json=0D
qapi: convert trivial intro sections for stats.json=0D
qapi: convert trivial intro sections for job.json=0D
qapi: convert intro sections for pci.json=0D
qapi: convert trivial intro sections for introspect.json=0D
qapi: convert intro sections for rocker.json=0D
qapi: convert trivial intro sections for misc-i386.json=0D
qapi: convert trivial intro sections for block-export.json=0D
qapi: convert intro sections for audio.json=0D
qapi: convert trivial intro sections for block.json=0D
qapi: convert trivial intro sections for misc.json=0D
qapi: convert trivial intro sections for crypto.json=0D
qapi: convert intro sections for cxl.json=0D
qapi: convert trivial intro sections for run-state.json=0D
qapi: convert intro sections for char.json=0D
qapi: convert intro sections for virtio.json=0D
qapi: convert trivial intro sections for net.json=0D
qapi: convert trivial intro sections for qom.json=0D
qapi: convert trivial intro sections for ui.json=0D
qapi: convert trivial intro sections for migration.json=0D
qapi: convert trivial intro sections for machine.json=0D
qapi: convert trivial intro sections for block-core.json=0D
=0D
qapi/accelerator.json | 18 +-=0D
qapi/acpi-hest.json | 4 +-=0D
qapi/acpi.json | 15 +-=0D
qapi/audio.json | 88 ++----=0D
qapi/authz.json | 21 +-=0D
qapi/block-core.json | 646 ++++++++++++++++-----------------------=0D
qapi/block-export.json | 87 +++---=0D
qapi/block.json | 58 ++--=0D
qapi/char.json | 90 ++----=0D
qapi/common.json | 36 +--=0D
qapi/compat.json | 6 +-=0D
qapi/control.json | 30 +-=0D
qapi/crypto.json | 118 +++----=0D
qapi/cryptodev.json | 18 +-=0D
qapi/cxl.json | 128 ++++----=0D
qapi/dump.json | 24 +-=0D
qapi/ebpf.json | 14 +-=0D
qapi/error.json | 3 +-=0D
qapi/introspect.json | 45 +--=0D
qapi/job.json | 18 +-=0D
qapi/machine-common.json | 19 +-=0D
qapi/machine-s390x.json | 20 +-=0D
qapi/machine.json | 261 ++++++----------=0D
qapi/migration.json | 201 +++++-------=0D
qapi/misc-arm.json | 15 +-=0D
qapi/misc-i386.json | 52 ++--=0D
qapi/misc.json | 74 ++---=0D
qapi/net.json | 101 +++---=0D
qapi/pci.json | 27 +-=0D
qapi/qdev.json | 23 +-=0D
qapi/qom.json | 138 +++------=0D
qapi/replay.json | 45 ++-=0D
qapi/rocker.json | 39 +--=0D
qapi/run-state.json | 120 +++-----=0D
qapi/sockets.json | 31 +-=0D
qapi/stats.json | 34 +--=0D
qapi/tpm.json | 29 +-=0D
qapi/trace.json | 12 +-=0D
qapi/transaction.json | 14 +-=0D
qapi/uefi.json | 5 +-=0D
qapi/ui.json | 215 +++++--------=0D
qapi/vfio.json | 19 +-=0D
qapi/virtio.json | 91 +++---=0D
qapi/yank.json | 25 +-=0D
44 files changed, 1165 insertions(+), 1912 deletions(-)=0D
=0D
--=20=0D
2.55.0=0D
=0D