diff options
| author | John Snow <jsnow@redhat.com> | 2024-06-26 18:21:19 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-07-06 08:58:24 +0200 |
| commit | 65fa48c79f20a37c7204f9e43dd7cc3058aa066c (patch) | |
| tree | eed31f99f53b7addba40c780bdebe51acff872a1 | |
| parent | 543ff13a20663b9aa93a4531fc75a1ebe7c69269 (diff) | |
| download | qemu-65fa48c79f20a37c7204f9e43dd7cc3058aa066c.zip qemu-65fa48c79f20a37c7204f9e43dd7cc3058aa066c.tar.gz qemu-65fa48c79f20a37c7204f9e43dd7cc3058aa066c.tar.bz2 | |
qapi/parser: don't parse rST markup as section headers
The double-colon synax is rST formatting that precedes a literal code
block. We do not want to capture these as QAPI-specific sections.
Coerce blocks that start with e.g. "Example::" to be parsed as untagged
paragraphs instead of special tagged sections.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20240626222128.406106-14-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Indentation tweaked for consistency]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
| -rw-r--r-- | scripts/qapi/parser.py | 9 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 3 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 3 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.txt | 3 |
4 files changed, 16 insertions, 2 deletions
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index 0a13f0f..6ad5663 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -544,10 +544,15 @@ class QAPISchemaParser: line = self.get_doc_indented(doc) no_more_args = True elif match := re.match( - r'(Returns|Errors|Since|Notes?|Examples?|TODO): *', - line): + r'(Returns|Errors|Since|Notes?|Examples?|TODO)' + r'(?!::): *', + line, + ): # tagged section + # Note: "sections" with two colons are left alone as + # rST markup and not interpreted as a section heading. + # TODO: Remove this error sometime in 2025 or so # after we've fully transitioned to the new qapidoc # generator. diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 32ff910..b565895 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -181,6 +181,9 @@ # - *verbatim* # - {braces} # +# Note:: +# Ceci n'est pas une note +# # Since: 2.10 ## { 'command': 'cmd', diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 631dc9f..a8e9456 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -190,6 +190,9 @@ frobnicate section=Examples - *verbatim* - {braces} + section=None +Note:: + Ceci n'est pas une note section=Since 2.10 doc symbol=cmd-boxed diff --git a/tests/qapi-schema/doc-good.txt b/tests/qapi-schema/doc-good.txt index d8bfa74..30d457e 100644 --- a/tests/qapi-schema/doc-good.txt +++ b/tests/qapi-schema/doc-good.txt @@ -231,6 +231,9 @@ Examples - *verbatim* - {braces} +Note:: + Ceci n'est pas une note + Since ~~~~~ |