[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup
From: |
Peter Maydell |
Subject: |
[PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup |
Date: |
Mon, 9 Mar 2020 15:43:51 +0000 |
doc-good.json tests some oddities of markup that we don't want to
accept. Make them match the more restrictive rST syntax:
* in a single list the bullet types must all match
* lists must have leading and following blank lines
* indentation is important
* 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.
Signed-off-by: Peter Maydell <address@hidden>
---
New patch in v2
---
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 d992e713d97..a45dc22848c 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -10,25 +10,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
@@ -62,7 +62,7 @@
##
# @Base:
# @base1:
-# the first member
+# the first member
##
{ 'struct': 'Base', 'data': { 'base1': 'Enum' } }
@@ -101,7 +101,7 @@
##
# @Alternate:
# @i: an integer
-# @b is undocumented
+# @b is undocumented
##
{ 'alternate': 'Alternate',
'data': { 'i': 'int', 'b': 'bool' } }
@@ -115,7 +115,7 @@
# @arg1: the first argument
#
# @arg2: the second
-# argument
+# argument
#
# Features:
# @cmd-feat1: a feature
@@ -124,6 +124,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 4c9406a464d..9503a3a3178 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -68,25 +68,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 d4b15dabf03..1e8063c8579 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.20.1
- [PATCH v4 00/18] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/03/09
- [PATCH v4 02/18] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/03/09
- [PATCH v4 03/18] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/03/09
- [PATCH v4 05/18] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/03/09
- [PATCH v4 04/18] tests/qapi/doc-good.json: Clean up markup,
Peter Maydell <=
- [PATCH v4 01/18] qapi/migration.json: Fix indentation, Peter Maydell, 2020/03/09
- [PATCH v4 06/18] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/03/09
- [PATCH v4 07/18] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/03/09
- [PATCH v4 08/18] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/03/09
- [PATCH v4 10/18] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/03/09