[PATCH v2 0/3] docs: remove legacy qapidoc

John Snow posted 3 patches 5 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20250612221051.1224565-1-jsnow@redhat.com
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, "Daniel P. Berrangé" <berrange@redhat.com>, Kashyap Chamarthy <kchamart@redhat.com>, Konstantin Kostiuk <kkostiuk@redhat.com>, Kevin Wolf <kwolf@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, Stefano Garzarella <sgarzare@redhat.com>, John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, Cleber Rosa <crosa@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Eric Blake <eblake@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Hanna Reitz <hreitz@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Gonglei (Arei)" <arei.gonglei@huawei.com>, Zhenwei Pi <pizhenwei@bytedance.com>, Jonathan Cameron <jonathan.cameron@huawei.com>, Fan Ni <fan.ni@samsung.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, Yanan Wang <wangyanan55@huawei.com>, Zhao Liu <zhao1.liu@intel.com>, Peter Xu <peterx@redhat.com>, Fabiano Rosas <farosas@suse.de>, Jason Wang <jasowang@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Jiri Pirko <jiri@resnulli.us>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Stefan Hajnoczi <stefanha@redhat.com>, Mads Ynddal <mads@ynddal.dk>, Alex Williamson <alex.williamson@redhat.com>, "Cédric Le Goater" <clg@redhat.com>, Lukas Straub <lukasstraub2@web.de>
There is a newer version of this series
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                       |  62 +--
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                       |   7 -
storage-daemon/qapi/qapi-schema.json         |   8 +-
tests/qapi-schema/doc-good.json              |  13 +-
52 files changed, 170 insertions(+), 572 deletions(-)
delete mode 100644 docs/sphinx/qapidoc_legacy.py
[PATCH v2 0/3] docs: remove legacy qapidoc
Posted by John Snow 5 months ago
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.

v2:
 - rebased on origin/master (2025-06-12)
 - Revised commit messages with increased detail

Markus: this one should be pretty short and sweet with good
payoff. Makes a good candidate for your first post-vacation review ;)

John Snow (3):
  docs: fix errors formatting in tests/qapi-schema/doc-good
  docs: remove legacy QAPI manual generator
  docs: remove special parsing for freeform sections

 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                       |  62 +--
 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                       |   7 -
 storage-daemon/qapi/qapi-schema.json         |   8 +-
 tests/qapi-schema/doc-good.json              |  13 +-
 52 files changed, 170 insertions(+), 572 deletions(-)
 delete mode 100644 docs/sphinx/qapidoc_legacy.py

-- 
2.48.1