From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Jiri Pirko" <jiri@resnulli.us>, "Fan Ni" <fan.ni@samsung.com>,
"Stefano Garzarella" <sgarzare@redhat.com>,
"Michael Roth" <michael.roth@amd.com>,
"Gonglei (Arei)" <arei.gonglei@huawei.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
qemu-block@nongnu.org, "Daniel P. Berrangé" <berrange@redhat.com>,
"Jonathan Cameron" <jonathan.cameron@huawei.com>,
"Fabiano Rosas" <farosas@suse.de>,
"Kashyap Chamarthy" <kchamart@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
"John Snow" <jsnow@redhat.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Hanna Reitz" <hreitz@redhat.com>, "Mads Ynddal" <mads@ynddal.dk>,
"Ani Sinha" <anisinha@redhat.com>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"Kevin Wolf" <kwolf@redhat.com>, "Eric Blake" <eblake@redhat.com>,
"Cédric Le Goater" <clg@redhat.com>,
"Peter Xu" <peterx@redhat.com>, "Cleber Rosa" <crosa@redhat.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Konstantin Kostiuk" <kkostiuk@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Alex Williamson" <alex.williamson@redhat.com>,
"Zhenwei Pi" <pizhenwei@bytedance.com>,
"Jason Wang" <jasowang@redhat.com>,
"Lukas Straub" <lukasstraub2@web.de>,
"Markus Armbruster" <armbru@redhat.com>
Subject: [PATCH v3 0/5] docs: remove legacy qapidoc
Date: Wed, 18 Jun 2025 12:53:48 -0400 [thread overview]
Message-ID: <20250618165353.1980365-1-jsnow@redhat.com> (raw)
Remove docs/sphinx/qapidoc_legacy.py, and remove special parsing of
freeform QAPI documentation block sections in favor of using standard
rST syntax that is included in the final document with no special
parsing or post-processing.
v3:
- Fixed indentation for :error: in qapidoc
- Removed parser restrictions on QAPI-style headers
- Updated test output so make check passes ...
v2:
- rebased on origin/master (2025-06-12)
- Revised commit messages with increased detail
John Snow (5):
docs/sphinx: adjust qapidoc to cope with same-line error sections
docs/sphinx: parse @references in freeform text
docs/sphinx: remove legacy QAPI manual generator
docs/sphinx: remove special parsing for freeform sections
qapi: lift restriction on using '=' in doc blocks
docs/devel/qapi-code-gen.rst | 28 +-
docs/interop/firmware.json | 4 +-
docs/interop/qemu-ga-ref.rst | 1 -
docs/interop/qemu-qmp-ref.rst | 1 -
docs/interop/qemu-storage-daemon-qmp-ref.rst | 1 -
docs/interop/vhost-user.json | 4 +-
docs/sphinx/qapidoc.py | 82 +---
docs/sphinx/qapidoc_legacy.py | 440 -------------------
qapi/acpi.json | 4 +-
qapi/audio.json | 4 +-
qapi/authz.json | 4 +-
qapi/block-core.json | 3 +-
qapi/block-export.json | 3 +-
qapi/block.json | 7 +-
qapi/char.json | 4 +-
qapi/common.json | 4 +-
qapi/compat.json | 4 +-
qapi/control.json | 4 +-
qapi/crypto.json | 4 +-
qapi/cryptodev.json | 4 +-
qapi/cxl.json | 4 +-
qapi/dump.json | 4 +-
qapi/ebpf.json | 4 +-
qapi/error.json | 4 +-
qapi/introspect.json | 4 +-
qapi/job.json | 4 +-
qapi/machine-common.json | 4 +-
qapi/machine.json | 4 +-
qapi/migration.json | 4 +-
qapi/misc.json | 4 +-
qapi/net.json | 4 +-
qapi/pci.json | 4 +-
qapi/qapi-schema.json | 4 +-
qapi/qdev.json | 4 +-
qapi/qom.json | 4 +-
qapi/replay.json | 4 +-
qapi/rocker.json | 4 +-
qapi/run-state.json | 4 +-
qapi/sockets.json | 4 +-
qapi/stats.json | 4 +-
qapi/tpm.json | 4 +-
qapi/trace.json | 4 +-
qapi/transaction.json | 4 +-
qapi/uefi.json | 4 +-
qapi/ui.json | 14 +-
qapi/vfio.json | 4 +-
qapi/virtio.json | 4 +-
qapi/yank.json | 4 +-
python/tests/qapi-isort.sh | 2 +-
scripts/qapi/parser.py | 11 -
storage-daemon/qapi/qapi-schema.json | 8 +-
tests/qapi-schema/doc-bad-section.err | 1 -
tests/qapi-schema/doc-bad-section.json | 10 -
tests/qapi-schema/doc-bad-section.out | 0
tests/qapi-schema/doc-good.json | 10 +-
tests/qapi-schema/doc-good.out | 10 +-
tests/qapi-schema/doc-good.txt | 274 ++++--------
tests/qapi-schema/meson.build | 1 -
58 files changed, 275 insertions(+), 784 deletions(-)
delete mode 100644 docs/sphinx/qapidoc_legacy.py
delete mode 100644 tests/qapi-schema/doc-bad-section.err
delete mode 100644 tests/qapi-schema/doc-bad-section.json
delete mode 100644 tests/qapi-schema/doc-bad-section.out
--
2.48.1
next reply other threads:[~2025-06-18 16:54 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-18 16:53 John Snow [this message]
2025-06-18 16:53 ` [PATCH v3 1/5] docs/sphinx: adjust qapidoc to cope with same-line error sections John Snow
2025-06-30 12:23 ` Markus Armbruster
2025-07-14 7:24 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 2/5] docs/sphinx: parse @references in freeform text John Snow
2025-06-27 9:54 ` Markus Armbruster
2025-06-27 16:40 ` John Snow
2025-06-18 16:53 ` [PATCH v3 3/5] docs/sphinx: remove legacy QAPI manual generator John Snow
2025-06-27 9:53 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 4/5] docs/sphinx: remove special parsing for freeform sections John Snow
2025-06-27 9:52 ` Markus Armbruster
2025-06-27 16:44 ` John Snow
2025-06-27 16:49 ` John Snow
2025-06-30 12:32 ` Markus Armbruster
2025-07-14 7:20 ` Markus Armbruster
2025-06-18 16:53 ` [PATCH v3 5/5] qapi: lift restriction on using '=' in doc blocks John Snow
2025-06-27 9:41 ` Markus Armbruster
2025-07-14 8:09 ` [PATCH v3 0/5] docs: remove legacy qapidoc Markus Armbruster
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=20250618165353.1980365-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=alex.williamson@redhat.com \
--cc=anisinha@redhat.com \
--cc=arei.gonglei@huawei.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=clg@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=fan.ni@samsung.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=jiri@resnulli.us \
--cc=jonathan.cameron@huawei.com \
--cc=kchamart@redhat.com \
--cc=kkostiuk@redhat.com \
--cc=kraxel@redhat.com \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=mads@ynddal.dk \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=michael.roth@amd.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=pizhenwei@bytedance.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=sgarzare@redhat.com \
--cc=stefanb@linux.vnet.ibm.com \
--cc=stefanha@redhat.com \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--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;
as well as URLs for NNTP newsgroup(s).