Commit 79598c8a authored by Markus Armbruster's avatar Markus Armbruster
Browse files

tests/qapi-schema: Cover feature documentation comments 



Commit 8aa3a33e "tests/qapi-schema: Test for good feature lists in
structs" neglected to cover documentation comments, and the previous
commit followed its example.  Make up for them.

Signed-off-by: default avatarMarkus Armbruster <armbru@redhat.com>
Message-Id: <20191018081454.21369-5-armbru@redhat.com>
Reviewed-by: default avatarEric Blake <eblake@redhat.com>
parent 2e2e0df2

tests/qapi-schema/doc-good.json

+15 −2
Original line number Diff line number Diff line
@@ -71,8 +71,12 @@ 
# A paragraph

#

# Another paragraph (but no @var: line)

#

# Features:

# @variant1-feat: a feature

##

{ 'struct': 'Variant1',

  'features': [ 'variant1-feat' ],

  'data': { 'var1': { 'type': 'str', 'if': 'defined(IFSTR)' } } }



##
@@ -104,6 +108,10 @@ 
#

# @arg2: the second

# argument

#

# Features:

# @cmd-feat1: a feature

# @cmd-feat2: another feature

# Note: @arg3 is undocumented

# Returns: @Object

# TODO: frobnicate
@@ -123,11 +131,15 @@ 
##

{ 'command': 'cmd',

  'data': { 'arg1': 'int', '*arg2': 'str', 'arg3': 'bool' },

  'returns': 'Object' }

  'returns': 'Object',

  'features': [ 'cmd-feat1', 'cmd-feat2' ] }



##

# @cmd-boxed:

# If you're bored enough to read this, go see a video of boxed cats

# Features:

# @cmd-feat1: a feature

# @cmd-feat2: another feature

# Example:

#

# -> in
@@ -135,4 +147,5 @@ 
# <- out

##

{ 'command': 'cmd-boxed', 'boxed': true,

  'data': 'Object' }
 
  'data': 'Object',

  'features': [ 'cmd-feat1', 'cmd-feat2' ] }

tests/qapi-schema/doc-good.out

+5 −0
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ object Base 
object Variant1

    member var1: str optional=False

        if ['defined(IFSTR)']

    feature variant1-feat

object Variant2

object Object

    base Base
@@ -47,8 +48,12 @@ object q_obj_cmd-arg 
    member arg3: bool optional=False

command cmd q_obj_cmd-arg -> Object

    gen=True success_response=True boxed=False oob=False preconfig=False

    feature cmd-feat1

    feature cmd-feat2

command cmd-boxed Object -> None

    gen=True success_response=True boxed=True oob=False preconfig=False

    feature cmd-feat1

    feature cmd-feat2

doc freeform

    body=

= Section

tests/qapi-schema/doc-good.texi

+22 −0
Original line number Diff line number Diff line
@@ -122,6 +122,12 @@ Not documented 
@*@b{If:} @code{defined(IFSTR)}

@end table



@b{Features:}

@table @asis

@item @code{variant1-feat}

a feature

@end table



@end deftp
@@ -182,6 +188,14 @@ argument 
Not documented

@end table



@b{Features:}

@table @asis

@item @code{cmd-feat1}

a feature

@item @code{cmd-feat2}

another feature

@end table



@b{Note:}

@code{arg3} is undocumented
@@ -227,6 +241,14 @@ If you're bored enough to read this, go see a video of boxed cats 


@b{Arguments:} the members of @code{Object}



@b{Features:}

@table @asis

@item @code{cmd-feat1}

a feature

@item @code{cmd-feat2}

another feature

@end table



@b{Example:}

@example

-> in