[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 15/16] qapi: Reject multiple and empty feature descriptions
From: |
Markus Armbruster |
Subject: |
[PATCH 15/16] qapi: Reject multiple and empty feature descriptions |
Date: |
Fri, 16 Feb 2024 15:58:39 +0100 |
The parser recognizes only the first "Features:" line. Any subsequent
ones are treated as ordinary text, as visible in test case
doc-duplicate-features. Recognize "Features:" lines anywhere. A
second one is an error.
A 'Features:' line without any features is useless, but not an error.
Make it an error. This makes detecting a second "Features:" line
easier.
qapi/run-state.json actually has an instance of this since commit
fe17522d854 (qapi: Remove deprecated 'singlestep' member of
StatusInfo). Clean it up.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/run-state.json | 2 --
scripts/qapi/parser.py | 8 ++++++-
tests/qapi-schema/doc-duplicate-features.err | 1 +
tests/qapi-schema/doc-duplicate-features.out | 22 --------------------
tests/qapi-schema/doc-empty-features.err | 1 +
tests/qapi-schema/doc-empty-features.out | 17 ---------------
6 files changed, 9 insertions(+), 42 deletions(-)
diff --git a/qapi/run-state.json b/qapi/run-state.json
index d19d23a0fd..dd0770b379 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -108,8 +108,6 @@
#
# @status: the virtual machine @RunState
#
-# Features:
-#
# Since: 0.14
#
##
diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py
index 73ff150430..3d8c62b412 100644
--- a/scripts/qapi/parser.py
+++ b/scripts/qapi/parser.py
@@ -507,7 +507,10 @@ def get_doc(self) -> 'QAPIDoc':
if line is None:
break
# Non-blank line, first of a section
- if line == 'Features:' and not doc.features:
+ if line == 'Features:':
+ if doc.features:
+ raise QAPIParseError(
+ self, "duplicated 'Features:' line")
self.accept(False)
line = self.get_doc_line()
while line == '':
@@ -520,6 +523,9 @@ def get_doc(self) -> 'QAPIDoc':
if text:
doc.append_line(text)
line = self.get_doc_indented(doc)
+ if not doc.features:
+ raise QAPIParseError(
+ self, 'feature descriptions expected')
no_more_args = True
elif match := self._match_at_name_colon(line):
# description
diff --git a/tests/qapi-schema/doc-duplicate-features.err
b/tests/qapi-schema/doc-duplicate-features.err
index e69de29bb2..cadb2957a6 100644
--- a/tests/qapi-schema/doc-duplicate-features.err
+++ b/tests/qapi-schema/doc-duplicate-features.err
@@ -0,0 +1 @@
+doc-duplicate-features.json:9:1: duplicated 'Features:' line
diff --git a/tests/qapi-schema/doc-duplicate-features.out
b/tests/qapi-schema/doc-duplicate-features.out
index 43bfe1034b..e69de29bb2 100644
--- a/tests/qapi-schema/doc-duplicate-features.out
+++ b/tests/qapi-schema/doc-duplicate-features.out
@@ -1,22 +0,0 @@
-module ./builtin
-object q_empty
-enum QType
- prefix QTYPE
- member none
- member qnull
- member qnum
- member qstring
- member qdict
- member qlist
- member qbool
-module doc-duplicate-features.json
-command foo None -> None
- gen=True success_response=True boxed=False oob=False preconfig=False
- feature feat
-doc symbol=foo
- body=
-
- feature=feat
-mumble
- section=None
-Features:
diff --git a/tests/qapi-schema/doc-empty-features.err
b/tests/qapi-schema/doc-empty-features.err
index e69de29bb2..2709a18d8f 100644
--- a/tests/qapi-schema/doc-empty-features.err
+++ b/tests/qapi-schema/doc-empty-features.err
@@ -0,0 +1 @@
+doc-empty-features.json:8:1: feature descriptions expected
diff --git a/tests/qapi-schema/doc-empty-features.out
b/tests/qapi-schema/doc-empty-features.out
index 473f59552d..e69de29bb2 100644
--- a/tests/qapi-schema/doc-empty-features.out
+++ b/tests/qapi-schema/doc-empty-features.out
@@ -1,17 +0,0 @@
-module ./builtin
-object q_empty
-enum QType
- prefix QTYPE
- member none
- member qnull
- member qnum
- member qstring
- member qdict
- member qlist
- member qbool
-module doc-empty-features.json
-command foo None -> None
- gen=True success_response=True boxed=False oob=False preconfig=False
-doc symbol=foo
- body=
-not a description
--
2.43.0
- [PATCH 01/16] tests/qapi-schema: Fix test 'QAPI rST doc', (continued)
- [PATCH 01/16] tests/qapi-schema: Fix test 'QAPI rST doc', Markus Armbruster, 2024/02/16
- [PATCH 05/16] qapi: Improve error position for bogus argument descriptions, Markus Armbruster, 2024/02/16
- [PATCH 13/16] qapi: Merge adjacent untagged sections, Markus Armbruster, 2024/02/16
- [PATCH 16/16] qapi: Divorce QAPIDoc from QAPIParseError, Markus Armbruster, 2024/02/16
- [PATCH 03/16] tests/qapi-schema: Cover 'Features:' not followed by descriptions, Markus Armbruster, 2024/02/16
- [PATCH 15/16] qapi: Reject multiple and empty feature descriptions,
Markus Armbruster <=
- [PATCH 08/16] qapi: Rename QAPIDoc.Section.name to .tag, Markus Armbruster, 2024/02/16
- [PATCH 02/16] tests/qapi-schema: Cover duplicate 'Features:' line, Markus Armbruster, 2024/02/16
- [PATCH 12/16] qapi: Call QAPIDoc.check() always, Markus Armbruster, 2024/02/16
- [PATCH 14/16] qapi: Rewrite doc comment parser, Markus Armbruster, 2024/02/16