I promised I'd remove this.
Signed-off-by: John Snow <[email protected]>
---
scripts/qapi/parser.py | 49 ++++++------------------------------------
1 file changed, 7 insertions(+), 42 deletions(-)
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index c14bff2cbc3..5fc9c18c81d 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -862,49 +862,15 @@ def _insert_near_kind(
return True
return False
- def _insert_after_intro(
- self,
- section: 'QAPIDoc.Section',
- ) -> None:
- """
- Insert a section immediately after the intro section.
-
- While we convert DETAILS sections to INTRO sections, all
- contiguous INTRO/DETAILS sections at the start of a QAPIDoc
- section list are treated as "the intro".
-
- Once INTRO conversion is complete, this helper will no longer be
- needed and ``_insert_near_kind(QAPIDoc.Kind.INTRO, ...)`` will
- be sufficient.
- """
- first = self.all_sections[0]
- if first.text and first.kind == QAPIDoc.Kind.INTRO:
- # First section is introduction and is non-empty: insert here.
- # Rest assured all of this ugliness will very soon go away.
- # Pinkie-swear.
- self.all_sections.insert(1, section)
- return
-
- index = 0
- for index, ref_section in enumerate(self.all_sections):
- if ref_section.kind.name in ("INTRO", "DETAILS"):
- continue
- break
- else:
- index += 1
-
- self.all_sections.insert(index, section)
-
def append_member_stub(self, stub: 'QAPIDoc.Section') -> None:
-
"""
Append a stub section after any Member sections.
"""
if self._insert_near_kind(QAPIDoc.Kind.MEMBER, stub, True):
return
- # No MEMBER sections present. Insert after INTRO/DETAILS sections.
- self._insert_after_intro(stub)
+ # No MEMBER sections present. Insert after INTRO section.
+ self._insert_near_kind(QAPIDoc.Kind.INTRO, stub, after=True)
def connect_member(self, member: 'QAPISchemaMember') -> None:
if member.name not in self._args:
@@ -932,10 +898,10 @@ def connect_feature(self, feature: 'QAPISchemaFeature')
-> None:
def ensure_returns(self, info: QAPISourceInfo) -> None:
# This is more complicated than it ought to be. The doc
# parser should already know where a generated RETURNS section
- # should go. It currently doesn't, mostly because it accepts
- # tagged sections in any order.
+ # should go. It currently doesn't.
#
- # TODO: Tighten doc syntax and simplify.
+ # TODO: Take advantage of the new strict section ordering and
+ # simplify this algorithm.
if any(s.kind == QAPIDoc.Kind.RETURNS for s in self.all_sections):
return
@@ -950,12 +916,11 @@ def ensure_returns(self, info: QAPISourceInfo) -> None:
(QAPIDoc.Kind.ERRORS, False),
# 3. Elif features, right *before* those.
(QAPIDoc.Kind.FEATURE, False),
+ # 4. Else, right *after* the intro.
+ (QAPIDoc.Kind.INTRO, True),
)):
return
- # Otherwise, it should go right after the intro.
- self._insert_after_intro(stub)
-
def check_expr(self, expr: QAPIExpression) -> None:
if 'command' in expr:
if self._returns and 'returns' not in expr:
--
2.55.0
