From: John Snow <[email protected]> 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 <[email protected]> Message-ID: <[email protected]> Reviewed-by: Markus Armbruster <[email protected]> [Commit message tweaked] Signed-off-by: Markus Armbruster <[email protected]> --- 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 09720a2c27..b7a7b9465a 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 b9829e2f84..16f4422177 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
