[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH 29/42] qapi: Add "Details:" disambiguation marker
From: |
Markus Armbruster |
Subject: |
Re: [PATCH 29/42] qapi: Add "Details:" disambiguation marker |
Date: |
Mon, 17 Feb 2025 12:55:02 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) |
John Snow <jsnow@redhat.com> writes:
> This clarifies sections that are mistaken by the parser as "intro"
> sections to be "details" sections instead.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> qapi/machine.json | 2 ++
> qapi/migration.json | 4 ++++
> qapi/qom.json | 4 ++++
> qapi/yank.json | 2 ++
> scripts/qapi/parser.py | 8 ++++++++
> 5 files changed, 20 insertions(+)
Missing updates for the new syntax
* Documentation: docs/devel/qapi-code-gen.rst
* Positive test case(s): tests/qapi-schema/doc-good.json
* Maybe a negative test case for _tag_check() failure
[...]
> diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
> index c5d2b950a82..5890a13b5ba 100644
> --- a/scripts/qapi/parser.py
> +++ b/scripts/qapi/parser.py
> @@ -544,6 +544,14 @@ def _tag_check(what: str) -> None:
> raise QAPIParseError(
> self, 'feature descriptions expected')
> have_tagged = True
> + elif line == 'Details:':
> + _tag_check("Details")
This one.
> + self.accept(False)
> + line = self.get_doc_line()
> + while line == '':
> + self.accept(False)
> + line = self.get_doc_line()
> + have_tagged = True
> elif match := self._match_at_name_colon(line):
> # description
> if have_tagged:
[PATCH 30/42] docs/qapidoc: add minimalistic inliner, John Snow, 2025/02/05
[PATCH 31/42] docs/qapidoc: autogenerate undocumented return docs, John Snow, 2025/02/05
[PATCH 32/42] docs/qapidoc: Add generated returns documentation to inliner, John Snow, 2025/02/05
[PATCH 33/42] docs/qmp: add target to Out-of-band execution section, John Snow, 2025/02/05
[PATCH 35/42] docs/qapidoc: generate out-of-band pseudofeature sections, John Snow, 2025/02/05