[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v6 23/27] qapi: add 'If:' condition to enum values d
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH v6 23/27] qapi: add 'If:' condition to enum values documentation |
Date: |
Fri, 6 Jul 2018 12:57:49 +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 | 1 +
tests/qapi-schema/doc-good.texi | 2 ++
4 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
index 76cb186ff9..196deea11d 100755
--- a/scripts/qapi/doc.py
+++ b/scripts/qapi/doc.py
@@ -128,7 +128,10 @@ def texi_body(doc):
def texi_enum_value(value):
"""Format a table of members item for an enumeration value"""
- return '@item @code{%s}\n' % value.name
+ return '@item @code{%s}%s\n' % (
+ value.name,
+ 'address@hidden:} @code{%s}\n' %
+ ', '.join(value.ifcond) if value.ifcond else '')
def texi_member(member, suffix=''):
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
index 984cd8ed06..c7fe08c530 100644
--- a/tests/qapi-schema/doc-good.json
+++ b/tests/qapi-schema/doc-good.json
@@ -55,7 +55,9 @@
#
# @two is undocumented
##
-{ 'enum': 'Enum', 'data': [ 'one', 'two' ], 'if': 'defined(IFCOND)' }
+{ 'enum': 'Enum', 'data':
+ [ { 'name': 'one', 'if': 'defined(IFENUM)' }, 'two' ],
+ 'if': 'defined(IFCOND)' }
##
# @Base:
diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
index c2fc5c774a..a05535b69b 100644
--- a/tests/qapi-schema/doc-good.out
+++ b/tests/qapi-schema/doc-good.out
@@ -11,6 +11,7 @@ enum QType
module doc-good.json
enum Enum
member one
+ if ['defined(IFENUM)']
member two
if ['defined(IFCOND)']
object Base
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index e42eace474..2446a1c702 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -83,6 +83,8 @@ Examples:
@b{Values:}
@table @asis
@item @code{one}
address@hidden:} @code{defined(IFENUM)}
+
The @emph{one} @{and address@hidden
@item @code{two}
Not documented
--
2.18.0.rc1
- [Qemu-devel] [PATCH v6 12/27] qapi: add a dictionnary form with 'name' key for enum members, (continued)
- [Qemu-devel] [PATCH v6 12/27] qapi: add a dictionnary form with 'name' key for enum members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 14/27] qapi-event: add 'if' condition to implicit event enum, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 13/27] qapi: add 'if' to enum members, Marc-André Lureau, 2018/07/06
- [Qemu-devel] [PATCH v6 15/27] qapi: rename allow_dict to allow_implicit, Marc-André Lureau, 2018/07/06
- [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 <=
- [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, 2018/07/06
- [Qemu-devel] [PATCH v6 27/27] qapi: add conditions to REPLICATION type/commands on the schema, Marc-André Lureau, 2018/07/06