1. Patchew
  2. QEMU
  3. [Qemu-devel] [PATCH 00/11] qapi: Cleanups around qapi2texi
  4. View patch

[Qemu-devel] [PATCH 05/11] tests/qapi-schema/doc-bad-section: New, factored out of doc-good

Markus Armbruster posted 11 patches 8 years, 4 months ago
[Qemu-devel] [PATCH 05/11] tests/qapi-schema/doc-bad-section: New, factored out of doc-good
Posted by Markus Armbruster 8 years, 4 months ago 
A negative test case crept into doc-good.json: invalid use of section
markup we currently fail to reject.  Move this into its own
doc-bad-section.json.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 tests/Makefile.include                 |  3 ++-
 tests/qapi-schema/doc-bad-section.err  |  0
 tests/qapi-schema/doc-bad-section.exit |  1 +
 tests/qapi-schema/doc-bad-section.json | 11 +++++++++++
 tests/qapi-schema/doc-bad-section.out  | 13 +++++++++++++
 tests/qapi-schema/doc-good.json        |  1 -
 tests/qapi-schema/doc-good.out         |  2 +-
 tests/qapi-schema/doc-good.texi        |  2 +-
 8 files changed, 29 insertions(+), 4 deletions(-)
 create mode 100644 tests/qapi-schema/doc-bad-section.err
 create mode 100644 tests/qapi-schema/doc-bad-section.exit
 create mode 100644 tests/qapi-schema/doc-bad-section.json
 create mode 100644 tests/qapi-schema/doc-bad-section.out

diff --git a/tests/Makefile.include b/tests/Makefile.include
index abc6707ef2..de4a713c25 100644
--- a/tests/Makefile.include
+++ b/tests/Makefile.include
@@ -412,6 +412,7 @@ qapi-schema += command-int.json
 qapi-schema += comments.json
 qapi-schema += doc-bad-alternate-member.json
 qapi-schema += doc-bad-command-arg.json
+qapi-schema += doc-bad-section.json
 qapi-schema += doc-bad-symbol.json
 qapi-schema += doc-bad-union-member.json
 qapi-schema += doc-before-include.json
@@ -429,10 +430,10 @@ qapi-schema += doc-invalid-end2.json
 qapi-schema += doc-invalid-return.json
 qapi-schema += doc-invalid-section.json
 qapi-schema += doc-invalid-start.json
-qapi-schema += doc-missing.json
 qapi-schema += doc-missing-colon.json
 qapi-schema += doc-missing-expr.json
 qapi-schema += doc-missing-space.json
+qapi-schema += doc-missing.json
 qapi-schema += doc-no-symbol.json
 qapi-schema += double-data.json
 qapi-schema += double-type.json
diff --git a/tests/qapi-schema/doc-bad-section.err b/tests/qapi-schema/doc-bad-section.err
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/qapi-schema/doc-bad-section.exit b/tests/qapi-schema/doc-bad-section.exit
new file mode 100644
index 0000000000..573541ac97
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-section.exit
@@ -0,0 +1 @@
+0
diff --git a/tests/qapi-schema/doc-bad-section.json b/tests/qapi-schema/doc-bad-section.json
new file mode 100644
index 0000000000..560df4b087
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-section.json
@@ -0,0 +1,11 @@
+# = section within an expression comment
+# BUG: not rejected
+
+##
+# @Enum:
+# == Produces *invalid* texinfo
+# @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
new file mode 100644
index 0000000000..6fce84dd34
--- /dev/null
+++ b/tests/qapi-schema/doc-bad-section.out
@@ -0,0 +1,13 @@
+enum Enum ['one', 'two']
+enum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 'qbool']
+    prefix QTYPE
+object q_empty
+doc symbol=Enum
+    body=
+== Produces *invalid* texinfo
+    arg=one
+The _one_ {and only}
+    arg=two
+
+    section=
+@two is undocumented
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index cfdc0a8a81..97ab4625ff 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -51,7 +51,6 @@
 
 ##
 # @Enum:
-# == Produces *invalid* texinfo
 # @one: The _one_ {and only}
 #
 # @two is undocumented
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index 63ca25a8b9..c55e394e8a 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -77,7 +77,7 @@ Examples:
 - {braces}
 doc symbol=Enum
     body=
-== Produces *invalid* texinfo
+
     arg=one
 The _one_ {and only}
     arg=two
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index c410626e4a..a331349756 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -76,7 +76,7 @@ Examples:
 
 @deftp {Enum} Enum
 
-@subsection Produces @strong{invalid} texinfo
+
 
 @b{Values:}
 @table @asis
-- 
2.13.6
Re: [Qemu-devel] [PATCH 05/11] tests/qapi-schema/doc-bad-section: New, factored out of doc-good
Posted by Marc-André Lureau 8 years, 4 months ago 
On Mon, Oct 2, 2017 at 4:13 PM, Markus Armbruster <armbru@redhat.com> wrote:
> A negative test case crept into doc-good.json: invalid use of section
> markup we currently fail to reject.  Move this into its own
> doc-bad-section.json.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>


> ---
>  tests/Makefile.include                 |  3 ++-
>  tests/qapi-schema/doc-bad-section.err  |  0
>  tests/qapi-schema/doc-bad-section.exit |  1 +
>  tests/qapi-schema/doc-bad-section.json | 11 +++++++++++
>  tests/qapi-schema/doc-bad-section.out  | 13 +++++++++++++
>  tests/qapi-schema/doc-good.json        |  1 -
>  tests/qapi-schema/doc-good.out         |  2 +-
>  tests/qapi-schema/doc-good.texi        |  2 +-
>  8 files changed, 29 insertions(+), 4 deletions(-)
>  create mode 100644 tests/qapi-schema/doc-bad-section.err
>  create mode 100644 tests/qapi-schema/doc-bad-section.exit
>  create mode 100644 tests/qapi-schema/doc-bad-section.json
>  create mode 100644 tests/qapi-schema/doc-bad-section.out
>
> diff --git a/tests/Makefile.include b/tests/Makefile.include
> index abc6707ef2..de4a713c25 100644
> --- a/tests/Makefile.include
> +++ b/tests/Makefile.include
> @@ -412,6 +412,7 @@ qapi-schema += command-int.json
>  qapi-schema += comments.json
>  qapi-schema += doc-bad-alternate-member.json
>  qapi-schema += doc-bad-command-arg.json
> +qapi-schema += doc-bad-section.json
>  qapi-schema += doc-bad-symbol.json
>  qapi-schema += doc-bad-union-member.json
>  qapi-schema += doc-before-include.json
> @@ -429,10 +430,10 @@ qapi-schema += doc-invalid-end2.json
>  qapi-schema += doc-invalid-return.json
>  qapi-schema += doc-invalid-section.json
>  qapi-schema += doc-invalid-start.json
> -qapi-schema += doc-missing.json
>  qapi-schema += doc-missing-colon.json
>  qapi-schema += doc-missing-expr.json
>  qapi-schema += doc-missing-space.json
> +qapi-schema += doc-missing.json
>  qapi-schema += doc-no-symbol.json
>  qapi-schema += double-data.json
>  qapi-schema += double-type.json
> diff --git a/tests/qapi-schema/doc-bad-section.err b/tests/qapi-schema/doc-bad-section.err
> new file mode 100644
> index 0000000000..e69de29bb2
> diff --git a/tests/qapi-schema/doc-bad-section.exit b/tests/qapi-schema/doc-bad-section.exit
> new file mode 100644
> index 0000000000..573541ac97
> --- /dev/null
> +++ b/tests/qapi-schema/doc-bad-section.exit
> @@ -0,0 +1 @@
> +0
> diff --git a/tests/qapi-schema/doc-bad-section.json b/tests/qapi-schema/doc-bad-section.json
> new file mode 100644
> index 0000000000..560df4b087
> --- /dev/null
> +++ b/tests/qapi-schema/doc-bad-section.json
> @@ -0,0 +1,11 @@
> +# = section within an expression comment
> +# BUG: not rejected
> +
> +##
> +# @Enum:
> +# == Produces *invalid* texinfo
> +# @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
> new file mode 100644
> index 0000000000..6fce84dd34
> --- /dev/null
> +++ b/tests/qapi-schema/doc-bad-section.out
> @@ -0,0 +1,13 @@
> +enum Enum ['one', 'two']
> +enum QType ['none', 'qnull', 'qnum', 'qstring', 'qdict', 'qlist', 'qbool']
> +    prefix QTYPE
> +object q_empty
> +doc symbol=Enum
> +    body=
> +== Produces *invalid* texinfo
> +    arg=one
> +The _one_ {and only}
> +    arg=two
> +
> +    section=
> +@two is undocumented
> diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
> index cfdc0a8a81..97ab4625ff 100644
> --- a/tests/qapi-schema/doc-good.json
> +++ b/tests/qapi-schema/doc-good.json
> @@ -51,7 +51,6 @@
>
>  ##
>  # @Enum:
> -# == Produces *invalid* texinfo
>  # @one: The _one_ {and only}
>  #
>  # @two is undocumented
> diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
> index 63ca25a8b9..c55e394e8a 100644
> --- a/tests/qapi-schema/doc-good.out
> +++ b/tests/qapi-schema/doc-good.out
> @@ -77,7 +77,7 @@ Examples:
>  - {braces}
>  doc symbol=Enum
>      body=
> -== Produces *invalid* texinfo
> +
>      arg=one
>  The _one_ {and only}
>      arg=two
> diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
> index c410626e4a..a331349756 100644
> --- a/tests/qapi-schema/doc-good.texi
> +++ b/tests/qapi-schema/doc-good.texi
> @@ -76,7 +76,7 @@ Examples:
>
>  @deftp {Enum} Enum
>
> -@subsection Produces @strong{invalid} texinfo
> +
>
>  @b{Values:}
>  @table @asis
> --
> 2.13.6
>
>



-- 
Marc-André Lureau

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.