[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx exten
From: |
Markus Armbruster |
Subject: |
[PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension |
Date: |
Tue, 29 Sep 2020 22:19:08 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
doc-good.json tests doc comment parser corner cases. We're about to
largely replace it by a Sphinx extension, which will have different
corner cases. Tweak the test so it passes both with the old parser
and the Sphinx extension, by making it match the more restrictive
rST syntax:
* in a single list the bullet types must all match
* lists must have leading and following blank lines
* the rules on when and where indentation matters differ
* the '|' example syntax is going to go away entirely, so stop
testing it
This will avoid the tests spuriously breaking when we tighten up the
parser code in the following commits.
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-4-peter.maydell@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
tests/qapi-schema/doc-good.json | 25 +++++++++++++------------
tests/qapi-schema/doc-good.out | 12 ++++++------
tests/qapi-schema/doc-good.texi | 12 +++---------
3 files changed, 22 insertions(+), 27 deletions(-)
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index 9da72a1f55..c6822145c4 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -12,25 +12,25 @@
#
# *strong* _with emphasis_
# @var {in braces}
+#
# * List item one
-# - Two, multiple
+# * Two, multiple
# lines
#
-# 3. Three
-# Still in list
+# * Three
+# Still in list
+#
+# Not in list
#
-# Not in list
# - Second list
-# Note: still in list
+# Note: still in list
#
# Note: not in list
+#
# 1. Third list
# is numbered
#
-# - another item
-#
-# | example
-# | multiple lines
+# 2. another item
#
# Returns: the King
# Since: the first age
@@ -68,7 +68,7 @@
##
# @Base:
# @base1:
-# the first member
+# the first member
##
{ 'struct': 'Base', 'data': { 'base1': 'Enum' } }
@@ -116,7 +116,7 @@
##
# @Alternate:
# @i: an integer
-# @b is undocumented
+# @b is undocumented
#
# Features:
# @alt-feat: a feature
@@ -134,7 +134,7 @@
# @arg1: the first argument
#
# @arg2: the second
-# argument
+# argument
#
# Features:
# @cmd-feat1: a feature
@@ -143,6 +143,7 @@
# Returns: @Object
# TODO: frobnicate
# Notes:
+#
# - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam
#
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index d78a424cd9..acb00ade17 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -75,25 +75,25 @@ doc freeform
*strong* _with emphasis_
@var {in braces}
+
* List item one
-- Two, multiple
+* Two, multiple
lines
-3. Three
+* Three
Still in list
Not in list
+
- Second list
Note: still in list
Note: not in list
+
1. Third list
is numbered
-- another item
-
-| example
-| multiple lines
+2. another item
Returns: the King
Since: the first age
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index 7f28fb7a0f..12808989ff 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -6,6 +6,7 @@
@strong{strong} @emph{with emphasis}
@code{var} @{in braces@}
+
@itemize @bullet
@item
List item one
@@ -20,6 +21,7 @@ Still in list
@end itemize
Not in list
+
@itemize @minus
@item
Second list
@@ -28,6 +30,7 @@ Note: still in list
@end itemize
Note: not in list
+
@enumerate
@item
Third list
@@ -36,15 +39,6 @@ is numbered
@item
another item
-@example
-example
-@end example
-
-@example
-multiple lines
-@end example
-
-
@end enumerate
Returns: the King
--
2.26.2
- [PULL 00/29] QAPI patches patches for 2020-09-29, Markus Armbruster, 2020/09/29
- [PULL 01/29] qapi: Restrict LostTickPolicy enum to machine code, Markus Armbruster, 2020/09/29
- [PULL 19/29] qga/qapi-schema.json: Add some headings, Markus Armbruster, 2020/09/29
- [PULL 10/29] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set, Markus Armbruster, 2020/09/29
- [PULL 04/29] qapi: Restrict query-vm-generation-id command to machine code, Markus Armbruster, 2020/09/29
- [PULL 07/29] qapi: Extract ACPI commands to 'acpi.json', Markus Armbruster, 2020/09/29
- [PULL 06/29] qapi: Restrict device memory commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 08/29] qapi: Extract PCI commands to 'pci.json', Markus Armbruster, 2020/09/29
- [PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension,
Markus Armbruster <=
- [PULL 03/29] qapi: Restrict balloon-related commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 09/29] qapi: Fix doc comment indentation again, Markus Armbruster, 2020/09/29
- [PULL 27/29] Remove Texinfo related line from git.orderfile, Markus Armbruster, 2020/09/29
- [PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis, Markus Armbruster, 2020/09/29
- [PULL 29/29] Remove texinfo dependency from docker and CI configs, Markus Armbruster, 2020/09/29
- [PULL 21/29] meson.build: Move SPHINX_ARGS to top level meson.build file, Markus Armbruster, 2020/09/29
- [PULL 16/29] docs/interop: Convert qemu-ga-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 26/29] scripts/texi2pod: Delete unused script, Markus Armbruster, 2020/09/29
- [PULL 28/29] configure: Drop texinfo requirement, Markus Armbruster, 2020/09/29
- [PULL 23/29] tests/qapi-schema: Add test of the rST QAPI doc-comment output, Markus Armbruster, 2020/09/29