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. ** 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 (13): tests/qapi: generate output in source order qapi/docs: remove unused QAPIDoc subsection members qapi/docs: make remaining subsection members "private" qapi/docs: add "Intro" section qapi/docs: adjust stub member insertion algorithm qapi/docs: remove implicit Plain section qapi/docs: add "Intro" section parsing qapi/docs: Add rendering for INTRO sections 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 rfc: intro starts on next line docs/devel/qapi-code-gen.rst | 17 ++- docs/sphinx/qapidoc.py | 53 +++++---- qapi/accelerator.json | 18 +-- qapi/acpi-hest.json | 4 +- qapi/acpi.json | 18 ++- qapi/audio.json | 88 ++++++--------- scripts/qapi/parser.py | 198 ++++++++++++++++++++------------- tests/qapi-schema/doc-good.out | 30 ++--- tests/qapi-schema/test-qapi.py | 15 +-- 9 files changed, 231 insertions(+), 210 deletions(-) -- 2.54.0
