aboutsummaryrefslogtreecommitdiff
path: root/tests/qapi-schema
diff options
context:
space:
mode:
Diffstat (limited to 'tests/qapi-schema')
-rw-r--r--tests/qapi-schema/doc-bad-section.err1
-rw-r--r--tests/qapi-schema/doc-bad-section.json10
-rw-r--r--tests/qapi-schema/doc-bad-section.out0
-rw-r--r--tests/qapi-schema/doc-good.json10
-rw-r--r--tests/qapi-schema/doc-good.out10
-rw-r--r--tests/qapi-schema/doc-good.txt274
-rw-r--r--tests/qapi-schema/doc-non-first-section.err1
-rw-r--r--tests/qapi-schema/doc-non-first-section.json6
-rw-r--r--tests/qapi-schema/doc-non-first-section.out0
-rw-r--r--tests/qapi-schema/meson.build1
-rwxr-xr-xtests/qapi-schema/test-qapi.py7
11 files changed, 105 insertions, 215 deletions
diff --git a/tests/qapi-schema/doc-bad-section.err b/tests/qapi-schema/doc-bad-section.err
deleted file mode 100644
index 785cacc..0000000
--- a/tests/qapi-schema/doc-bad-section.err
+++ /dev/null
@@ -1 +0,0 @@
-doc-bad-section.json:5:1: unexpected '=' markup in definition documentation
diff --git a/tests/qapi-schema/doc-bad-section.json b/tests/qapi-schema/doc-bad-section.json
deleted file mode 100644
index 8175d95..0000000
--- a/tests/qapi-schema/doc-bad-section.json
+++ /dev/null
@@ -1,10 +0,0 @@
-# = section within an expression comment
-
-##
-# @Enum:
-# == No good here
-# @one: The _one_ {and only}
-#
-# @two is undocumented
-##
-{ 'enum': 'Enum', 'data': [ 'one', 'two' ] }
diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out
deleted file mode 100644
index e69de29..0000000
--- a/tests/qapi-schema/doc-bad-section.out
+++ /dev/null
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index 14b808f..fac1342 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -8,7 +8,9 @@
'documentation-exceptions': [ 'Enum', 'Variant1', 'Alternate', 'cmd' ] } }
##
-# = Section
+# *******
+# Section
+# *******
##
##
@@ -16,7 +18,8 @@
##
##
-# == Subsection
+# Subsection
+# ==========
#
# *with emphasis*
# @var {in braces}
@@ -144,7 +147,8 @@
'if': { 'not': { 'any': [ 'IFONE', 'IFTWO' ] } } }
##
-# == Another subsection
+# Another subsection
+# ==================
##
##
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index dc8352e..04a5507 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -55,13 +55,16 @@ event EVT_BOXED Object
feature feat3
doc freeform
body=
-= Section
+*******
+Section
+*******
doc freeform
body=
Just text, no heading.
doc freeform
body=
-== Subsection
+Subsection
+==========
*with emphasis*
@var {in braces}
@@ -155,7 +158,8 @@ description starts on the same line
a feature
doc freeform
body=
-== Another subsection
+Another subsection
+==================
doc symbol=cmd
body=
diff --git a/tests/qapi-schema/doc-good.txt b/tests/qapi-schema/doc-good.txt
index 17a1d56..74b7368 100644
--- a/tests/qapi-schema/doc-good.txt
+++ b/tests/qapi-schema/doc-good.txt
@@ -1,6 +1,8 @@
Section
*******
+Just text, no heading.
+
Subsection
==========
@@ -35,249 +37,145 @@ Example:
-> in <- out Examples: - *verbatim* - {braces}
+Enum Enum
+ *Availability*: "IFCOND"
-"Enum" (Enum)
--------------
-
-
-Values
-~~~~~~
-
-"one" (**If: **"IFONE")
- The _one_ {and only}, description on the same line
-
-"two"
- Not documented
-
-
-Features
-~~~~~~~~
-
-"enum-feat"
- Also _one_ {and only}
-
-"enum-member-feat"
- a member feature
-
-"two" is undocumented
-
-
-If
-~~
-
-"IFCOND"
-
-
-"Base" (Object)
----------------
-
-
-Members
-~~~~~~~
-
-"base1": "Enum"
- description starts on a new line, minimally indented
-
-
-If
-~~
-
-"IFALL1 and IFALL2"
-
-
-"Variant1" (Object)
--------------------
-
-A paragraph
-
-Another paragraph
-
-"var1" is undocumented
+ Values:
+ * **one** -- The _one_ {and only}, description on the same line
+ * **two** -- Not documented
-Members
-~~~~~~~
+ Features:
+ * **enum-feat** -- Also _one_ {and only}
-"var1": "string" (**If: **"IFSTR")
- Not documented
+ * **enum-member-feat** -- a member feature
+ "two" is undocumented
-Features
-~~~~~~~~
+Object Base
+ *Availability*: "IFALL1 and IFALL2"
-"variant1-feat"
- a feature
+ Members:
+ * **base1** ("Enum") -- description starts on a new line,
+ minimally indented
-"member-feat"
- a member feature
+Object Variant1
+ A paragraph
-"Variant2" (Object)
--------------------
+ Another paragraph
+ "var1" is undocumented
-"Object" (Object)
------------------
+ Members:
+ * **var1** ("string") -- Not documented
+ Features:
+ * **variant1-feat** -- a feature
-Members
-~~~~~~~
+ * **member-feat** -- a member feature
-The members of "Base"
-The members of "Variant1" when "base1" is ""one""
-The members of "Variant2" when "base1" is ""two"" (**If: **"IFONE or
-IFTWO")
+Object Variant2
-Features
-~~~~~~~~
+Object Object
-"union-feat1"
- a feature
+ Members:
+ * The members of "Base".
+ * When "base1" is "one": The members of "Variant1".
-"Alternate" (Alternate)
------------------------
+ * When "base1" is "two": The members of "Variant2".
+ Features:
+ * **union-feat1** -- a feature
-Members
-~~~~~~~
+Alternate Alternate
+ *Availability*: "not (IFONE or IFTWO)"
-"i": "int"
- description starts on the same line remainder indented the same "b"
- is undocumented
+ Alternatives:
+ * **i** ("int") -- description starts on the same line remainder
+ indented the same "b" is undocumented
-"b": "boolean"
- Not documented
+ * **b** ("boolean") -- Not documented
-
-Features
-~~~~~~~~
-
-"alt-feat"
- a feature
-
-
-If
-~~
-
-"not (IFONE or IFTWO)"
+ Features:
+ * **alt-feat** -- a feature
Another subsection
==================
+Command cmd (Since: 2.10)
-"cmd" (Command)
----------------
-
-
-Arguments
-~~~~~~~~~
-
-"arg1": "int"
- description starts on a new line, indented
-
-"arg2": "string" (optional)
- description starts on the same line remainder indented differently
-
-"arg3": "boolean"
- Not documented
-
-
-Features
-~~~~~~~~
-
-"cmd-feat1"
- a feature
+ Arguments:
+ * **arg1** ("int") -- description starts on a new line, indented
-"cmd-feat2"
- another feature
-
-Note:
-
- "arg3" is undocumented
-
-
-Returns
-~~~~~~~
-
-"Object"
-
-
-Errors
-~~~~~~
-
-some
-
-Notes:
-
-* Lorem ipsum dolor sit amet
-
-* Ut enim ad minim veniam
-
-Duis aute irure dolor
+ * **arg2** ("string", *optional*) -- description starts on the
+ same line remainder indented differently
-Example: Ideal fast-food burger situation:
+ * **arg3** ("boolean") -- Not documented
- -> "in"
- <- "out"
+ Features:
+ * **cmd-feat1** -- a feature
-Examples:
+ * **cmd-feat2** -- another feature
- - Not a QMP code block
- - Merely a preformatted code block literal
- It isn't even an rST list.
- - *verbatim*
- - {braces}
+ Note:
-Note::
- Ceci n'est pas une note
+ "arg3" is undocumented
+ Return:
+ "Object" -- "Object"
-Since
-~~~~~
+ Errors:
+ some
-2.10
+ Notes:
+ * Lorem ipsum dolor sit amet
-"cmd-boxed" (Command)
----------------------
+ * Ut enim ad minim veniam
-If you're bored enough to read this, go see a video of boxed cats
+ Duis aute irure dolor
+ Example: Ideal fast-food burger situation:
-Arguments
-~~~~~~~~~
+ -> "in"
+ <- "out"
-The members of "Object"
+ Examples:
-Features
-~~~~~~~~
+ - Not a QMP code block
+ - Merely a preformatted code block literal
+ It isn't even an rST list.
+ - *verbatim*
+ - {braces}
-"cmd-feat1"
- a feature
+ Note::
+ Ceci n'est pas une note
-"cmd-feat2"
- another feature
+Command cmd-boxed
-Example::
+ If you're bored enough to read this, go see a video of boxed cats
- -> "this example"
+ Arguments:
+ * The members of "Object".
- <- ... has no title ...
+ Features:
+ * **cmd-feat1** -- a feature
+ * **cmd-feat2** -- another feature
-"EVT_BOXED" (Event)
--------------------
+ Example::
+ -> "this example"
-Arguments
-~~~~~~~~~
+ <- ... has no title ...
-The members of "Object"
+Event EVT_BOXED
-Features
-~~~~~~~~
+ Members:
+ * The members of "Object".
-"feat3"
- a feature
+ Features:
+ * **feat3** -- a feature
diff --git a/tests/qapi-schema/doc-non-first-section.err b/tests/qapi-schema/doc-non-first-section.err
deleted file mode 100644
index eeced2b..0000000
--- a/tests/qapi-schema/doc-non-first-section.err
+++ /dev/null
@@ -1 +0,0 @@
-doc-non-first-section.json:5:1: '=' heading must come first in a comment block
diff --git a/tests/qapi-schema/doc-non-first-section.json b/tests/qapi-schema/doc-non-first-section.json
deleted file mode 100644
index 1590876..0000000
--- a/tests/qapi-schema/doc-non-first-section.json
+++ /dev/null
@@ -1,6 +0,0 @@
-# = section must be first line
-
-##
-#
-# = Not first
-##
diff --git a/tests/qapi-schema/doc-non-first-section.out b/tests/qapi-schema/doc-non-first-section.out
deleted file mode 100644
index e69de29..0000000
--- a/tests/qapi-schema/doc-non-first-section.out
+++ /dev/null
diff --git a/tests/qapi-schema/meson.build b/tests/qapi-schema/meson.build
index 9577178..c47025d 100644
--- a/tests/qapi-schema/meson.build
+++ b/tests/qapi-schema/meson.build
@@ -61,7 +61,6 @@ schemas = [
'doc-bad-event-arg.json',
'doc-bad-feature.json',
'doc-bad-indent.json',
- 'doc-bad-section.json',
'doc-bad-symbol.json',
'doc-bad-union-member.json',
'doc-before-include.json',
diff --git a/tests/qapi-schema/test-qapi.py b/tests/qapi-schema/test-qapi.py
index 4be9302..cf7fb8a 100755
--- a/tests/qapi-schema/test-qapi.py
+++ b/tests/qapi-schema/test-qapi.py
@@ -165,7 +165,7 @@ def test_and_diff(test_name, dir_name, update):
if actual_out == expected_out and actual_err == expected_err:
return 0
- print("%s %s" % (test_name, 'UPDATE' if update else 'FAIL'),
+ print("%s: %s" % (test_name, 'UPDATE' if update else 'FAIL'),
file=sys.stderr)
out_diff = difflib.unified_diff(expected_out, actual_out, outfp.name)
err_diff = difflib.unified_diff(expected_err, actual_err, errfp.name)
@@ -173,6 +173,9 @@ def test_and_diff(test_name, dir_name, update):
sys.stdout.writelines(err_diff)
if not update:
+ print(("\n%s: set QEMU_TEST_REGENERATE=1 to recreate reference output" +
+ "if the QAPI schema generator was intentionally changed") % test_name,
+ file=sys.stderr)
return 1
try:
@@ -197,7 +200,7 @@ def main(argv):
parser.add_argument('-d', '--dir', action='store', default='',
help="directory containing tests")
parser.add_argument('-u', '--update', action='store_true',
- default='QAPI_TEST_UPDATE' in os.environ,
+ default='QEMU_TEST_REGENERATE' in os.environ,
help="update expected test results")
parser.add_argument('tests', nargs='*', metavar='TEST', action='store')
args = parser.parse_args()
generated by cgit v1.1 at 2025-10-15 07:44:35 +0000