[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v6 25/27] qapi: add condition to variants documentat
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH v6 25/27] qapi: add condition to variants documentation |
Date: |
Fri, 6 Jul 2018 12:57:51 +0200 |
Signed-off-by: Marc-André Lureau <address@hidden>
---
scripts/qapi/doc.py | 5 +++--
tests/qapi-schema/doc-good.json | 4 ++--
tests/qapi-schema/doc-good.out | 3 +++
tests/qapi-schema/doc-good.texi | 4 ++--
4 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
index 56dc98c068..e9dfdc7d23 100755
--- a/scripts/qapi/doc.py
+++ b/scripts/qapi/doc.py
@@ -165,8 +165,9 @@ def texi_members(doc, what, base, variants, member_func):
items += '@item The members of @code{%s}\n' % base.doc_type()
if variants:
for v in variants.variants:
- when = ' when @code{%s} is @t{"%s"}' % (
- variants.tag_member.name, v.name)
+ when = ' when @code{%s} is @t{"%s"}%s' % (
+ variants.tag_member.name, v.name,
+ ' (@b{If:} @code{%s})' % v.ifcond if v.ifcond else '')
if v.type.is_implicit():
assert not v.type.base and not v.type.variants
for m in v.type.local_members:
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index 158443b1a3..afe46d93f0 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -86,13 +86,13 @@
{ 'union': 'Object',
'base': 'Base',
'discriminator': 'base1',
- 'data': { 'one': 'Variant1', 'two': 'Variant2' } }
+ 'data': { 'one': 'Variant1', 'two': { 'type': 'Variant2', 'if': 'IFTWO' } } }
##
# @SugaredUnion:
##
{ 'union': 'SugaredUnion',
- 'data': { 'one': 'Variant1', 'two': 'Variant2' } }
+ 'data': { 'one': 'Variant1', 'two': { 'type': 'Variant2', 'if': 'IFTWO' } } }
##
# == Another subsection
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index c310b47be2..ed647b82be 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -25,6 +25,7 @@ object Object
tag base1
case one: Variant1
case two: Variant2
+ if ['IFTWO']
object q_obj_Variant1-wrapper
member data: Variant1 optional=False
object q_obj_Variant2-wrapper
@@ -32,11 +33,13 @@ object q_obj_Variant2-wrapper
enum SugaredUnionKind
member one
member two
+ if ['IFTWO']
object SugaredUnion
member type: SugaredUnionKind optional=False
tag type
case one: q_obj_Variant1-wrapper
case two: q_obj_Variant2-wrapper
+ if ['IFTWO']
object q_obj_cmd-arg
member arg1: int optional=False
member arg2: str optional=True
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index 255eed9a30..6e226a6231 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -145,7 +145,7 @@ Not documented
@table @asis
@item The members of @code{Base}
@item The members of @code{Variant1} when @code{base1} is @t{"one"}
address@hidden The members of @code{Variant2} when @code{base1} is @t{"two"}
address@hidden The members of @code{Variant2} when @code{base1} is @t{"two"}
(@b{If:} @code{['IFTWO']})
@end table
@end deftp
@@ -161,7 +161,7 @@ Not documented
@item @code{type}
One of @t{"one"}, @t{"two"}
@item @code{data: Variant1} when @code{type} is @t{"one"}
address@hidden @code{data: Variant2} when @code{type} is @t{"two"}
address@hidden @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:}
@code{['IFTWO']})
@end table
@end deftp
--
2.18.0.rc1
- [Qemu-devel] [PATCH v6 16/27] qapi: add a dictionary form with 'type' key for members, (continued)
- [Qemu-devel] [PATCH v6 16/27] qapi: add a dictionary form with 'type' key for members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 18/27] qapi: add an error in case a discriminator is conditionnal, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 17/27] qapi: add 'if' to implicit struct members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 19/27] qapi: add 'if' on union members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 20/27] qapi: add 'if' to alternate members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 21/27] qapi: add #if conditions to generated code members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 23/27] qapi: add 'If:' condition to enum values documentation, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 24/27] qapi: add 'If:' condition to struct members documentation, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 26/27] qapi: add more conditions to SPICE, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 22/27] docs: document schema configuration, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 25/27] qapi: add condition to variants documentation,
Marc-André Lureau <=
- [Qemu-devel] [PATCH v6 27/27] qapi: add conditions to REPLICATION type/commands on the schema, Marc-André Lureau, 2018/07/06