Skip to content

docs: remove legacy qapidoc

John Snow qemu-devel 3 versions – Applied

Status from this message: Queued, thanks!

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest5 patches 12 repliesApplied
  2. v23 patches 6 repliesSuperseded
  3. v13 patches 3 repliesSuperseded

Changes in v3 from the cover letter

- Fixed indentation for :error: in qapidoc
- Removed parser restrictions on QAPI-style headers
- Updated test output so make check passes ...

Patches in v3 Applied

#Subject and filesSizeRepliesApplied
1/5docs/sphinx: adjust qapidoc to cope with same-line error sectionsdocs/sphinx/qapidoc.py+8 -42 replies
2/5docs/sphinx: parse @references in freeform textdocs/sphinx/qapidoc.py+7 -32 replies
3/5docs/sphinx: remove legacy QAPI manual generatordocs/interop/qemu-ga-ref.rst docs/interop/qemu-qmp-ref.rst docs/interop/qemu-storage-daemon-qmp-ref.rst +4 more+88 -6561 reply
4/5docs/sphinx: remove special parsing for freeform sectionsdocs/devel/qapi-code-gen.rst docs/interop/firmware.json docs/interop/vhost-user.json +45 more+173 -1065 replies
5/5qapi: lift restriction on using '=' in doc blocksscripts/qapi/parser.py tests/qapi-schema/doc-bad-section.err tests/qapi-schema/doc-bad-section.json +2 more+0 -161 reply

Reviews trailers per patch

None of the 5 patches has a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchMarkus Armbruster
SeriesA-b R-b
1/5
2/5
3/5
4/5
5/5

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [PATCH v3 0/5] docs: remove legacy qapidoc

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
Signature · 1 line
2.48.1