[00/11] qapi: Documentation improvements

Message

Markus Armbruster April 4, 2025, 12:14 p.m. UTC

Markus Armbruster (11):
  docs/devel/qapi-code-gen: Tidy up whitespace
  qapi/rocker: Tidy up query-rocker-of-dpa-flows example
  docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC
  docs/interop: Sanitize QMP reference manuals TOC
  docs/devel/qapi-code-gen: Improve the part on qmp-example directive
  docs/sphinx/qmp_lexer: Generalize elision syntax
  docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts
  qapi/qapi-schema: Update introduction for example notation
  qapi/qapi-schema: Address the introduction's bit rot
  storage-daemon/qapi/qapi-schema: Add a proper introduction
  qga/qapi-schema: Add a proper introduction

 docs/devel/qapi-code-gen.rst                 | 53 ++++++++++++--------
 docs/interop/qemu-ga-ref.rst                 |  3 --
 docs/interop/qemu-qmp-ref.rst                |  2 +-
 docs/interop/qemu-storage-daemon-qmp-ref.rst |  2 +-
 docs/sphinx/qmp_lexer.py                     |  2 +-
 qapi/qapi-schema.json                        | 31 ++++--------
 qapi/rocker.json                             |  2 +-
 qga/qapi-schema.json                         | 20 ++++++--
 storage-daemon/qapi/qapi-schema.json         | 22 ++++++--
 tests/qapi-schema/doc-good.json              |  2 +-
 tests/qapi-schema/doc-good.out               |  2 +-
 tests/qapi-schema/doc-good.txt               |  2 +-
 12 files changed, 83 insertions(+), 60 deletions(-)