Re: [Qemu-devel] [PATCH v6 24/27] qapi: add 'If:' condition to struct members documentation

[Markus Armbruster]

Marc-André Lureau <address@hidden> writes:

> Signed-off-by: Marc-André Lureau <address@hidden>
> ---
>  scripts/qapi/doc.py             | 4 +++-
>  tests/qapi-schema/doc-good.json | 3 ++-
>  tests/qapi-schema/doc-good.out  | 1 +
>  tests/qapi-schema/doc-good.texi | 2 ++
>  4 files changed, 8 insertions(+), 2 deletions(-)
>
> diff --git a/scripts/qapi/doc.py b/scripts/qapi/doc.py
> index 196deea11d..56dc98c068 100755
> --- a/scripts/qapi/doc.py
> +++ b/scripts/qapi/doc.py
> @@ -138,9 +138,11 @@ def texi_member(member, suffix=''):
>      """Format a table of members item for an object type member"""
>      typ = member.type.doc_type()
>      membertype = ': ' + typ if typ else ''
> -    return '@item @code{%s%s}%s%s\n' % (
> +    return '@item @code{%s%s}%s%s%s\n' % (
>          member.name, membertype,
>          ' (optional)' if member.optional else '',
> +        'address@hidden:} @code{%s}\n' %
> +        ', '.join(member.ifcond) if member.ifcond else '',
>          suffix)
>  
>  
> diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json
> index c7fe08c530..158443b1a3 100644
> --- a/tests/qapi-schema/doc-good.json
> +++ b/tests/qapi-schema/doc-good.json
> @@ -72,7 +72,8 @@
>  #
>  # Another paragraph (but no @var: line)
>  ##
> -{ 'struct': 'Variant1', 'data': { 'var1': 'str' } }
> +{ 'struct': 'Variant1',
> +  'data': { 'var1': { 'type': 'str', 'if': 'defined(IFSTR)' } } }
>  
>  ##
>  # @Variant2:
> diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out
> index a05535b69b..c310b47be2 100644
> --- a/tests/qapi-schema/doc-good.out
> +++ b/tests/qapi-schema/doc-good.out
> @@ -18,6 +18,7 @@ object Base
>      member base1: Enum optional=False
>  object Variant1
>      member var1: str optional=False
> +        if ['defined(IFSTR)']
>  object Variant2
>  object Object
>      base Base
> diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
> index 2446a1c702..255eed9a30 100644
> --- a/tests/qapi-schema/doc-good.texi
> +++ b/tests/qapi-schema/doc-good.texi
> @@ -120,6 +120,8 @@ Another paragraph (but no @code{var}: line)
>  @b{Members:}
>  @table @asis
>  @item @code{var1: string}
> address@hidden:} @code{defined(IFSTR)}
> +
>  Not documented
>  @end table

Comments on the previous patch apply.