motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 04:13:53 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Recognize section tags and 'Features:' only after blank line

Browse source 
Putting a blank line before section tags and 'Features:' is good,
existing practice.  Enforce it.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240216145841.2099240-12-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-16 15:58:35 +01:00
parent d23055b8db
commit 66227e9047
9 changed files with 32 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

11
scripts/qapi/parser.py
View file

@ -538,6 +538,7 @@ class QAPIDoc:
# the current section
self._section = self.body
self._append_line = self._append_body_line
self._first_line_in_paragraph = False
def has_section(self, tag: str) -> bool:
"""Return True if we have a section with this tag."""
@ -560,12 +561,14 @@ class QAPIDoc:
line = line[1:]
if not line:
self._append_freeform(line)
self._first_line_in_paragraph = True
return
if line[0] != ' ':
raise QAPIParseError(self._parser, "missing space after #")
line = line[1:]
self._append_line(line)
self._first_line_in_paragraph = False
def end_comment(self) -> None:
self._switch_section(QAPIDoc.NullSection(self._parser))
@ -574,9 +577,11 @@ class QAPIDoc:
def _match_at_name_colon(string: str) -> Optional[Match[str]]:
return re.match(r'@([^:]*): *', string)
@staticmethod
def _match_section_tag(string: str) -> Optional[Match[str]]:
return re.match(r'(Returns|Since|Notes?|Examples?|TODO): *', string)
def _match_section_tag(self, string: str) -> Optional[Match[str]]:
if not self._first_line_in_paragraph:
return None
return re.match(r'(Returns|Since|Notes?|Examples?|TODO): *',
string)
def _append_body_line(self, line: str) -> None:
"""