[PATCH v3 00/16] qapi: add formal "intro" section

John Snow posted 16 patches 5 days, 2 hours ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20260603032201.993015-1-jsnow@redhat.com
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>, John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>, Mauro Carvalho Chehab <mchehab+huawei@kernel.org>, Cleber Rosa <crosa@redhat.com>, Eric Blake <eblake@redhat.com>, Richard Henderson <richard.henderson@linaro.org>, Paolo Bonzini <pbonzini@redhat.com>, "Philippe Mathieu-Daudé" <philmd@mailo.com>, "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <anisinha@redhat.com>, Gerd Hoffmann <kraxel@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>
docs/devel/qapi-code-gen.rst   |  16 ++--
docs/sphinx/qapidoc.py         |  59 +++++++-----
qapi/accelerator.json          |  18 ++--
qapi/acpi-hest.json            |   4 +-
qapi/acpi.json                 |  18 ++--
qapi/audio.json                |  88 +++++++-----------
python/setup.cfg               |   3 +-
scripts/qapi/parser.py         | 162 +++++++++++++++++++--------------
tests/qapi-schema/doc-good.out |  86 ++++++++---------
tests/qapi-schema/test-qapi.py |  14 +--
10 files changed, 236 insertions(+), 232 deletions(-)
[PATCH v3 00/16] qapi: add formal "intro" section
Posted by John Snow 5 days, 2 hours ago
Hiya, this is a series that explores a potential syntax for a
designated "Intro" section. Markus knows why I want this, but for
everyone else: a designated "Introduction" section is useful for the
desired "inliner" feature for the new QAPI doc system. Commits explain
a bit more. This is prep work and doesn't really change anything
tangibly except source code syntax for the QAPI docs.

It is designed so that this conversion can happen incrementally with
no actual difference to the rendered manuals, so each QAPI module can
be converted one at a time for easier review and merging in an
arbitrary order.

This series demonstrates conversion of just four modules; if I'm given
a thumbs up, I will convert the rest of QAPI, one module (or
maintainer stanza) per patch like how I handled adding
cross-references.

**

V3: changed intro section syntax, made various fixes and changes; I'm
going to be honest Markus I did not keep a strict account this time
;_;

V2: punt intro sections to the subsequent line and adjust the parser
accordingly. Left as an RFC patch that undoes some things this series
does instead of properly factoring into the series.

John Snow (16):
  python: temporarily restrict max mypy version
  tests/qapi: generate output in source order
  qapi/docs: remove unused QAPIDoc subsection members
  qapi/docs: add has_features property
  qapi/docs: make remaining subsection members "private"
  qapi/docs: fix comment phrasing
  qapi/docs: add "Intro" section
  qapi/parser: move _insert_near_kind() method
  qapi/docs: adjust stub member insertion algorithm
  qapi/docs: remove implicit Plain section
  qapi/docs: add rendering for INTRO sections
  qapi/docs: add "Intro" section parsing
  qapi: convert intro sections for accelerator.json
  qapi: convert intro sections for acpi-hest.json
  qapi: convert intro sections for acpi.json
  qapi: convert intro sections for audio.json

 docs/devel/qapi-code-gen.rst   |  16 ++--
 docs/sphinx/qapidoc.py         |  59 +++++++-----
 qapi/accelerator.json          |  18 ++--
 qapi/acpi-hest.json            |   4 +-
 qapi/acpi.json                 |  18 ++--
 qapi/audio.json                |  88 +++++++-----------
 python/setup.cfg               |   3 +-
 scripts/qapi/parser.py         | 162 +++++++++++++++++++--------------
 tests/qapi-schema/doc-good.out |  86 ++++++++---------
 tests/qapi-schema/test-qapi.py |  14 +--
 10 files changed, 236 insertions(+), 232 deletions(-)

-- 
2.54.0