From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Ani Sinha" <anisinha@redhat.com>,
"Michael Roth" <michael.roth@amd.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"John Snow" <jsnow@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Eric Blake" <eblake@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Michael S. Tsirkin" <mst@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Pierrick Bouvier" <pierrick.bouvier@oss.qualcomm.com>,
"Richard Henderson" <richard.henderson@linaro.org>,
"Gerd Hoffmann" <kraxel@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
linux-edac@vger.kernel.org, "Cleber Rosa" <crosa@redhat.com>
Subject: [PATCH v3 10/16] qapi/docs: remove implicit Plain section
Date: Tue, 2 Jun 2026 23:21:55 -0400 [thread overview]
Message-ID: <20260603032201.993015-11-jsnow@redhat.com> (raw)
In-Reply-To: <20260603032201.993015-1-jsnow@redhat.com>
Prior to this patch, we always create an empty Plain section. Removing
this allows us to gradually phase out the "Plain" section in favor of
"Intro" and "Details" sections while keeping "Plain" around for the
interim churn during the series - meaning that we don't actually know
at __init__ time which type of section we'll have first.
Signed-off-by: John Snow <jsnow@redhat.com>
---
scripts/qapi/parser.py | 4 +---
tests/qapi-schema/doc-good.out | 14 --------------
2 files changed, 1 insertion(+), 17 deletions(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 406edf6aa9d..4beec4f9eda 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -730,9 +730,7 @@ def __init__(self, info: QAPISourceInfo, symbol: Optional[str] = None):
# definition doc's symbol, None for free-form doc
self.symbol: Optional[str] = symbol
# the sections in textual order
- self.all_sections: List[QAPIDoc.Section] = [
- QAPIDoc.Section(info, QAPIDoc.Kind.PLAIN)
- ]
+ self.all_sections: List[QAPIDoc.Section] = []
# dicts mapping parameter/feature names to their description
self._args: Dict[str, QAPIDoc.ArgSection] = {}
self._features: Dict[str, QAPIDoc.ArgSection] = {}
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index b9829e2f841..16f44221771 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -106,8 +106,6 @@ Examples:
- *verbatim*
- {braces}
doc symbol=Enum
- Plain
-
Member=one
The _one_ {and only}, description on the same line
Member=two
@@ -119,8 +117,6 @@ a member feature
Plain
@two is undocumented
doc symbol=Base
- Plain
-
Member=base1
description starts on a new line,
minimally indented
@@ -138,16 +134,10 @@ a feature
Feature=member-feat
a member feature
doc symbol=Variant2
- Plain
-
doc symbol=Object
- Plain
-
Feature=union-feat1
a feature
doc symbol=Alternate
- Plain
-
Member=i
description starts on the same line
remainder indented the same
@@ -161,8 +151,6 @@ doc freeform
Another subsection
==================
doc symbol=cmd
- Plain
-
Member=arg1
description starts on a new line,
indented
@@ -223,7 +211,5 @@ another feature
<- ... has no title ...
doc symbol=EVT_BOXED
- Plain
-
Feature=feat3
a feature
--
2.54.0
next prev parent reply other threads:[~2026-06-03 3:22 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-06-03 3:21 [PATCH v3 00/16] qapi: add formal "intro" section John Snow
2026-06-03 3:21 ` [PATCH v3 01/16] python: temporarily restrict max mypy version John Snow
2026-06-03 3:21 ` [PATCH v3 02/16] tests/qapi: generate output in source order John Snow
2026-06-03 3:21 ` [PATCH v3 03/16] qapi/docs: remove unused QAPIDoc subsection members John Snow
2026-06-03 3:21 ` [PATCH v3 04/16] qapi/docs: add has_features property John Snow
2026-06-03 3:21 ` [PATCH v3 05/16] qapi/docs: make remaining subsection members "private" John Snow
2026-06-03 3:21 ` [PATCH v3 06/16] qapi/docs: fix comment phrasing John Snow
2026-06-03 3:21 ` [PATCH v3 07/16] qapi/docs: add "Intro" section John Snow
2026-06-09 10:58 ` Markus Armbruster
2026-06-09 18:06 ` John Snow
2026-06-03 3:21 ` [PATCH v3 08/16] qapi/parser: move _insert_near_kind() method John Snow
2026-06-03 3:21 ` [PATCH v3 09/16] qapi/docs: adjust stub member insertion algorithm John Snow
2026-06-03 11:27 ` Markus Armbruster
2026-06-04 19:07 ` John Snow
2026-06-09 13:32 ` Markus Armbruster
2026-06-09 18:44 ` John Snow
2026-06-03 3:21 ` John Snow [this message]
2026-06-03 3:21 ` [PATCH v3 11/16] qapi/docs: add rendering for INTRO sections John Snow
2026-06-09 13:36 ` Markus Armbruster
2026-06-09 18:51 ` John Snow
2026-06-03 3:21 ` [PATCH v3 12/16] qapi/docs: add "Intro" section parsing John Snow
2026-06-09 13:39 ` Markus Armbruster
2026-06-09 18:57 ` John Snow
2026-06-03 3:21 ` [PATCH v3 13/16] qapi: convert intro sections for accelerator.json John Snow
2026-06-03 3:21 ` [PATCH v3 14/16] qapi: convert intro sections for acpi-hest.json John Snow
2026-06-03 3:22 ` [PATCH v3 15/16] qapi: convert intro sections for acpi.json John Snow
2026-06-03 3:22 ` [PATCH v3 16/16] qapi: convert intro sections for audio.json 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=20260603032201.993015-11-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.