From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Michael Roth" <michael.roth@amd.com>,
"Eric Blake" <eblake@redhat.com>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
linux-edac@vger.kernel.org, "John Snow" <jsnow@redhat.com>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Pierrick Bouvier" <pierrick.bouvier@oss.qualcomm.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Richard Henderson" <richard.henderson@linaro.org>
Subject: [PATCH v4 00/13] qapi: add formal "intro" section
Date: Thu, 11 Jun 2026 00:23:19 -0400 [thread overview]
Message-ID: <20260611042332.482979-1-jsnow@redhat.com> (raw)
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.
V4: A few minor comment touch-ups; omitted module conversions.
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 (13):
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/parser: add mea culpa comment for ensure_returns
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
docs/devel/qapi-code-gen.rst | 16 ++--
docs/sphinx/qapidoc.py | 61 +++++++-----
python/setup.cfg | 3 +-
scripts/qapi/parser.py | 167 +++++++++++++++++++--------------
tests/qapi-schema/doc-good.out | 86 +++++++++--------
tests/qapi-schema/test-qapi.py | 14 +--
6 files changed, 197 insertions(+), 150 deletions(-)
--
2.54.0
next reply other threads:[~2026-06-11 4:23 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-06-11 4:23 John Snow [this message]
2026-06-11 4:23 ` [PATCH v4 01/13] python: temporarily restrict max mypy version John Snow
2026-06-11 4:23 ` [PATCH v4 02/13] tests/qapi: generate output in source order John Snow
2026-06-11 4:23 ` [PATCH v4 03/13] qapi/docs: remove unused QAPIDoc subsection members John Snow
2026-06-11 4:23 ` [PATCH v4 04/13] qapi/docs: add has_features property John Snow
2026-06-11 4:23 ` [PATCH v4 05/13] qapi/docs: make remaining subsection members "private" John Snow
2026-06-11 4:23 ` [PATCH v4 06/13] qapi/docs: fix comment phrasing John Snow
2026-06-11 4:23 ` [PATCH v4 07/13] qapi/docs: add "Intro" section John Snow
2026-06-11 4:23 ` [PATCH v4 08/13] qapi/parser: move _insert_near_kind() method John Snow
2026-06-11 4:23 ` [PATCH v4 09/13] qapi/parser: add mea culpa comment for ensure_returns John Snow
2026-06-11 4:23 ` [PATCH v4 10/13] qapi/docs: adjust stub member insertion algorithm John Snow
2026-06-11 4:23 ` [PATCH v4 11/13] qapi/docs: remove implicit Plain section John Snow
2026-06-11 4:23 ` [PATCH v4 12/13] qapi/docs: add rendering for INTRO sections John Snow
2026-06-11 4:23 ` [PATCH v4 13/13] qapi/docs: add "Intro" section parsing John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260611042332.482979-1-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=eblake@redhat.com \
--cc=imammedo@redhat.com \
--cc=kraxel@redhat.com \
--cc=linux-edac@vger.kernel.org \
--cc=marcandre.lureau@redhat.com \
--cc=mchehab+huawei@kernel.org \
--cc=michael.roth@amd.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=philmd@mailo.com \
--cc=pierrick.bouvier@oss.qualcomm.com \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox