Commit 01ae9cc2 authored by Marc-André Lureau's avatar Marc-André Lureau Committed by Markus Armbruster
Browse files

qapi: add condition to variants documentation 



Signed-off-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20181213123724.4866-21-marcandre.lureau@redhat.com>
Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent 8867bf08

scripts/qapi/doc.py

+2 −2
Original line number Diff line number Diff line
@@ -168,8 +168,8 @@ 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, texi_if(v.ifcond, " (", ")"))

            if v.type.is_implicit():

                assert not v.type.base and not v.type.variants

                for m in v.type.local_members:

tests/qapi-schema/doc-good.json

+2 −2
Original line number Diff line number Diff line
@@ -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

tests/qapi-schema/doc-good.out

+3 −0
Original line number Diff line number Diff line
@@ -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

tests/qapi-schema/doc-good.texi

+2 −2
Original line number Diff line number Diff line
@@ -142,7 +142,7 @@ Not documented 
@table @asis

@item The members of @code{Base}

@item The members of @code{Variant1} when @code{base1} is @t{"one"}

@item The members of @code{Variant2} when @code{base1} is @t{"two"}

@item The members of @code{Variant2} when @code{base1} is @t{"two"} (@b{If:} @code{IFTWO})

@end table



@end deftp
@@ -158,7 +158,7 @@ Not documented 
@item @code{type}

One of @t{"one"}, @t{"two"}

@item @code{data: Variant1} when @code{type} is @t{"one"}

@item @code{data: Variant2} when @code{type} is @t{"two"}

@item @code{data: Variant2} when @code{type} is @t{"two"} (@b{If:} @code{IFTWO})

@end table



@end deftp