mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-07-27 04:13:53 -06:00
scripts/qapi: Remove texinfo generation support
We no longer use the generated texinfo format documentation, so delete the code that generates it, and the test case for the generation. Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Message-Id: <20200925162316.21205-17-peter.maydell@linaro.org> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Peter Maydell
Markus Armbruster
parent
ca1145ee88
commit
a27ff0a249
6 changed files with 1 additions and 634 deletions
|
|
@ -619,7 +619,6 @@ qapi_gen = find_program('scripts/qapi-gen.py')
|
||||||
qapi_gen_depends = [ meson.source_root() / 'scripts/qapi/__init__.py',
|
qapi_gen_depends = [ meson.source_root() / 'scripts/qapi/__init__.py',
|
||||||
meson.source_root() / 'scripts/qapi/commands.py',
|
meson.source_root() / 'scripts/qapi/commands.py',
|
||||||
meson.source_root() / 'scripts/qapi/common.py',
|
meson.source_root() / 'scripts/qapi/common.py',
|
||||||
meson.source_root() / 'scripts/qapi/doc.py',
|
|
||||||
meson.source_root() / 'scripts/qapi/error.py',
|
meson.source_root() / 'scripts/qapi/error.py',
|
||||||
meson.source_root() / 'scripts/qapi/events.py',
|
meson.source_root() / 'scripts/qapi/events.py',
|
||||||
meson.source_root() / 'scripts/qapi/expr.py',
|
meson.source_root() / 'scripts/qapi/expr.py',
|
||||||
|
|
@ -631,7 +630,6 @@ qapi_gen_depends = [ meson.source_root() / 'scripts/qapi/__init__.py',
|
||||||
meson.source_root() / 'scripts/qapi/types.py',
|
meson.source_root() / 'scripts/qapi/types.py',
|
||||||
meson.source_root() / 'scripts/qapi/visit.py',
|
meson.source_root() / 'scripts/qapi/visit.py',
|
||||||
meson.source_root() / 'scripts/qapi/common.py',
|
meson.source_root() / 'scripts/qapi/common.py',
|
||||||
meson.source_root() / 'scripts/qapi/doc.py',
|
|
||||||
meson.source_root() / 'scripts/qapi-gen.py'
|
meson.source_root() / 'scripts/qapi-gen.py'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,6 @@ import re
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
from qapi.commands import gen_commands
|
from qapi.commands import gen_commands
|
||||||
from qapi.doc import gen_doc
|
|
||||||
from qapi.events import gen_events
|
from qapi.events import gen_events
|
||||||
from qapi.introspect import gen_introspect
|
from qapi.introspect import gen_introspect
|
||||||
from qapi.schema import QAPIError, QAPISchema
|
from qapi.schema import QAPIError, QAPISchema
|
||||||
|
|
@ -51,7 +50,6 @@ def main(argv):
|
||||||
gen_commands(schema, args.output_dir, args.prefix)
|
gen_commands(schema, args.output_dir, args.prefix)
|
||||||
gen_events(schema, args.output_dir, args.prefix)
|
gen_events(schema, args.output_dir, args.prefix)
|
||||||
gen_introspect(schema, args.output_dir, args.prefix, args.unmask)
|
gen_introspect(schema, args.output_dir, args.prefix, args.unmask)
|
||||||
gen_doc(schema, args.output_dir, args.prefix)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|
|
||||||
|
|
@ -1,302 +0,0 @@
|
||||||
# QAPI texi generator
|
|
||||||
#
|
|
||||||
# This work is licensed under the terms of the GNU LGPL, version 2+.
|
|
||||||
# See the COPYING file in the top-level directory.
|
|
||||||
"""This script produces the documentation of a qapi schema in texinfo format"""
|
|
||||||
|
|
||||||
import re
|
|
||||||
from qapi.gen import QAPIGenDoc, QAPISchemaVisitor
|
|
||||||
|
|
||||||
|
|
||||||
MSG_FMT = """
|
|
||||||
@deftypefn {type} {{}} {name}
|
|
||||||
|
|
||||||
{body}{members}{features}{sections}
|
|
||||||
@end deftypefn
|
|
||||||
|
|
||||||
""".format
|
|
||||||
|
|
||||||
TYPE_FMT = """
|
|
||||||
@deftp {{{type}}} {name}
|
|
||||||
|
|
||||||
{body}{members}{features}{sections}
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
""".format
|
|
||||||
|
|
||||||
EXAMPLE_FMT = """@example
|
|
||||||
{code}
|
|
||||||
@end example
|
|
||||||
""".format
|
|
||||||
|
|
||||||
|
|
||||||
def subst_strong(doc):
|
|
||||||
"""Replaces *foo* by @strong{foo}"""
|
|
||||||
return re.sub(r'\*([^*\n]+)\*', r'@strong{\1}', doc)
|
|
||||||
|
|
||||||
|
|
||||||
def subst_emph(doc):
|
|
||||||
"""Replaces _foo_ by @emph{foo}"""
|
|
||||||
return re.sub(r'\b_([^_\n]+)_\b', r'@emph{\1}', doc)
|
|
||||||
|
|
||||||
|
|
||||||
def subst_vars(doc):
|
|
||||||
"""Replaces @var by @code{var}"""
|
|
||||||
return re.sub(r'@([\w-]+)', r'@code{\1}', doc)
|
|
||||||
|
|
||||||
|
|
||||||
def subst_braces(doc):
|
|
||||||
"""Replaces {} with @{ @}"""
|
|
||||||
return doc.replace('{', '@{').replace('}', '@}')
|
|
||||||
|
|
||||||
|
|
||||||
def texi_example(doc):
|
|
||||||
"""Format @example"""
|
|
||||||
# TODO: Neglects to escape @ characters.
|
|
||||||
# We should probably escape them in subst_braces(), and rename the
|
|
||||||
# function to subst_special() or subs_texi_special(). If we do that, we
|
|
||||||
# need to delay it until after subst_vars() in texi_format().
|
|
||||||
doc = subst_braces(doc).strip('\n')
|
|
||||||
return EXAMPLE_FMT(code=doc)
|
|
||||||
|
|
||||||
|
|
||||||
def texi_format(doc):
|
|
||||||
"""
|
|
||||||
Format documentation
|
|
||||||
|
|
||||||
Lines starting with:
|
|
||||||
- |: generates an @example
|
|
||||||
- =: generates @section
|
|
||||||
- ==: generates @subsection
|
|
||||||
- 1. or 1): generates an @enumerate @item
|
|
||||||
- */-: generates an @itemize list
|
|
||||||
"""
|
|
||||||
ret = ''
|
|
||||||
doc = subst_braces(doc)
|
|
||||||
doc = subst_vars(doc)
|
|
||||||
doc = subst_emph(doc)
|
|
||||||
doc = subst_strong(doc)
|
|
||||||
inlist = ''
|
|
||||||
lastempty = False
|
|
||||||
for line in doc.split('\n'):
|
|
||||||
line = line.strip()
|
|
||||||
empty = line == ''
|
|
||||||
|
|
||||||
# FIXME: Doing this in a single if / elif chain is
|
|
||||||
# problematic. For instance, a line without markup terminates
|
|
||||||
# a list if it follows a blank line (reaches the final elif),
|
|
||||||
# but a line with some *other* markup, such as a = title
|
|
||||||
# doesn't.
|
|
||||||
#
|
|
||||||
# Make sure to update section "Documentation markup" in
|
|
||||||
# docs/devel/qapi-code-gen.txt when fixing this.
|
|
||||||
if line.startswith('| '):
|
|
||||||
line = EXAMPLE_FMT(code=line[2:])
|
|
||||||
elif line.startswith('= '):
|
|
||||||
line = '@section ' + line[2:]
|
|
||||||
elif line.startswith('== '):
|
|
||||||
line = '@subsection ' + line[3:]
|
|
||||||
elif re.match(r'^([0-9]*\.) ', line):
|
|
||||||
if not inlist:
|
|
||||||
ret += '@enumerate\n'
|
|
||||||
inlist = 'enumerate'
|
|
||||||
ret += '@item\n'
|
|
||||||
line = line[line.find(' ')+1:]
|
|
||||||
elif re.match(r'^[*-] ', line):
|
|
||||||
if not inlist:
|
|
||||||
ret += '@itemize %s\n' % {'*': '@bullet',
|
|
||||||
'-': '@minus'}[line[0]]
|
|
||||||
inlist = 'itemize'
|
|
||||||
ret += '@item\n'
|
|
||||||
line = line[2:]
|
|
||||||
elif lastempty and inlist:
|
|
||||||
ret += '@end %s\n\n' % inlist
|
|
||||||
inlist = ''
|
|
||||||
|
|
||||||
lastempty = empty
|
|
||||||
ret += line + '\n'
|
|
||||||
|
|
||||||
if inlist:
|
|
||||||
ret += '@end %s\n\n' % inlist
|
|
||||||
return ret
|
|
||||||
|
|
||||||
|
|
||||||
def texi_body(doc):
|
|
||||||
"""Format the main documentation body"""
|
|
||||||
return texi_format(doc.body.text)
|
|
||||||
|
|
||||||
|
|
||||||
def texi_if(ifcond, prefix='\n', suffix='\n'):
|
|
||||||
"""Format the #if condition"""
|
|
||||||
if not ifcond:
|
|
||||||
return ''
|
|
||||||
return '%s@b{If:} @code{%s}%s' % (prefix, ', '.join(ifcond), suffix)
|
|
||||||
|
|
||||||
|
|
||||||
def texi_enum_value(value, desc, suffix):
|
|
||||||
"""Format a table of members item for an enumeration value"""
|
|
||||||
return '@item @code{%s}\n%s%s' % (
|
|
||||||
value.name, desc, texi_if(value.ifcond, prefix='@*'))
|
|
||||||
|
|
||||||
|
|
||||||
def texi_member(member, desc, 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%s%s' % (
|
|
||||||
member.name, membertype,
|
|
||||||
' (optional)' if member.optional else '',
|
|
||||||
suffix, desc, texi_if(member.ifcond, prefix='@*'))
|
|
||||||
|
|
||||||
|
|
||||||
def texi_members(doc, what, base=None, variants=None,
|
|
||||||
member_func=texi_member):
|
|
||||||
"""Format the table of members"""
|
|
||||||
items = ''
|
|
||||||
for section in doc.args.values():
|
|
||||||
# TODO Drop fallbacks when undocumented members are outlawed
|
|
||||||
if section.text:
|
|
||||||
desc = texi_format(section.text)
|
|
||||||
elif (variants and variants.tag_member == section.member
|
|
||||||
and not section.member.type.doc_type()):
|
|
||||||
values = section.member.type.member_names()
|
|
||||||
members_text = ', '.join(['@t{"%s"}' % v for v in values])
|
|
||||||
desc = 'One of ' + members_text + '\n'
|
|
||||||
else:
|
|
||||||
desc = 'Not documented\n'
|
|
||||||
items += member_func(section.member, desc, suffix='')
|
|
||||||
if base:
|
|
||||||
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"}%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:
|
|
||||||
items += member_func(m, desc='', suffix=when)
|
|
||||||
else:
|
|
||||||
items += '@item The members of @code{%s}%s\n' % (
|
|
||||||
v.type.doc_type(), when)
|
|
||||||
if not items:
|
|
||||||
return ''
|
|
||||||
return '\n@b{%s:}\n@table @asis\n%s@end table\n' % (what, items)
|
|
||||||
|
|
||||||
|
|
||||||
def texi_arguments(doc, boxed_arg_type):
|
|
||||||
if boxed_arg_type:
|
|
||||||
assert not doc.args
|
|
||||||
return ('\n@b{Arguments:} the members of @code{%s}\n'
|
|
||||||
% boxed_arg_type.name)
|
|
||||||
return texi_members(doc, 'Arguments')
|
|
||||||
|
|
||||||
|
|
||||||
def texi_features(doc):
|
|
||||||
"""Format the table of features"""
|
|
||||||
items = ''
|
|
||||||
for section in doc.features.values():
|
|
||||||
desc = texi_format(section.text)
|
|
||||||
items += '@item @code{%s}\n%s' % (section.name, desc)
|
|
||||||
if not items:
|
|
||||||
return ''
|
|
||||||
return '\n@b{Features:}\n@table @asis\n%s@end table\n' % (items)
|
|
||||||
|
|
||||||
|
|
||||||
def texi_sections(doc, ifcond):
|
|
||||||
"""Format additional sections following arguments"""
|
|
||||||
body = ''
|
|
||||||
for section in doc.sections:
|
|
||||||
if section.name:
|
|
||||||
# prefer @b over @strong, so txt doesn't translate it to *Foo:*
|
|
||||||
body += '\n@b{%s:}\n' % section.name
|
|
||||||
if section.name and section.name.startswith('Example'):
|
|
||||||
body += texi_example(section.text)
|
|
||||||
else:
|
|
||||||
body += texi_format(section.text)
|
|
||||||
body += texi_if(ifcond, suffix='')
|
|
||||||
return body
|
|
||||||
|
|
||||||
|
|
||||||
def texi_type(typ, doc, ifcond, members):
|
|
||||||
return TYPE_FMT(type=typ,
|
|
||||||
name=doc.symbol,
|
|
||||||
body=texi_body(doc),
|
|
||||||
members=members,
|
|
||||||
features=texi_features(doc),
|
|
||||||
sections=texi_sections(doc, ifcond))
|
|
||||||
|
|
||||||
|
|
||||||
def texi_msg(typ, doc, ifcond, members):
|
|
||||||
return MSG_FMT(type=typ,
|
|
||||||
name=doc.symbol,
|
|
||||||
body=texi_body(doc),
|
|
||||||
members=members,
|
|
||||||
features=texi_features(doc),
|
|
||||||
sections=texi_sections(doc, ifcond))
|
|
||||||
|
|
||||||
|
|
||||||
class QAPISchemaGenDocVisitor(QAPISchemaVisitor):
|
|
||||||
def __init__(self, prefix):
|
|
||||||
self._prefix = prefix
|
|
||||||
self._gen = QAPIGenDoc(self._prefix + 'qapi-doc.texi')
|
|
||||||
self.cur_doc = None
|
|
||||||
|
|
||||||
def write(self, output_dir):
|
|
||||||
self._gen.write(output_dir)
|
|
||||||
|
|
||||||
def visit_enum_type(self, name, info, ifcond, features, members, prefix):
|
|
||||||
doc = self.cur_doc
|
|
||||||
self._gen.add(texi_type('Enum', doc, ifcond,
|
|
||||||
texi_members(doc, 'Values',
|
|
||||||
member_func=texi_enum_value)))
|
|
||||||
|
|
||||||
def visit_object_type(self, name, info, ifcond, features,
|
|
||||||
base, members, variants):
|
|
||||||
doc = self.cur_doc
|
|
||||||
if base and base.is_implicit():
|
|
||||||
base = None
|
|
||||||
self._gen.add(texi_type('Object', doc, ifcond,
|
|
||||||
texi_members(doc, 'Members', base, variants)))
|
|
||||||
|
|
||||||
def visit_alternate_type(self, name, info, ifcond, features, variants):
|
|
||||||
doc = self.cur_doc
|
|
||||||
self._gen.add(texi_type('Alternate', doc, ifcond,
|
|
||||||
texi_members(doc, 'Members')))
|
|
||||||
|
|
||||||
def visit_command(self, name, info, ifcond, features,
|
|
||||||
arg_type, ret_type, gen, success_response, boxed,
|
|
||||||
allow_oob, allow_preconfig):
|
|
||||||
doc = self.cur_doc
|
|
||||||
self._gen.add(texi_msg('Command', doc, ifcond,
|
|
||||||
texi_arguments(doc,
|
|
||||||
arg_type if boxed else None)))
|
|
||||||
|
|
||||||
def visit_event(self, name, info, ifcond, features, arg_type, boxed):
|
|
||||||
doc = self.cur_doc
|
|
||||||
self._gen.add(texi_msg('Event', doc, ifcond,
|
|
||||||
texi_arguments(doc,
|
|
||||||
arg_type if boxed else None)))
|
|
||||||
|
|
||||||
def symbol(self, doc, entity):
|
|
||||||
if self._gen._body:
|
|
||||||
self._gen.add('\n')
|
|
||||||
self.cur_doc = doc
|
|
||||||
entity.visit(self)
|
|
||||||
self.cur_doc = None
|
|
||||||
|
|
||||||
def freeform(self, doc):
|
|
||||||
assert not doc.args
|
|
||||||
if self._gen._body:
|
|
||||||
self._gen.add('\n')
|
|
||||||
self._gen.add(texi_body(doc) + texi_sections(doc, None))
|
|
||||||
|
|
||||||
|
|
||||||
def gen_doc(schema, output_dir, prefix):
|
|
||||||
vis = QAPISchemaGenDocVisitor(prefix)
|
|
||||||
vis.visit_begin(schema)
|
|
||||||
for doc in schema.docs:
|
|
||||||
if doc.symbol:
|
|
||||||
vis.symbol(doc, schema.lookup_entity(doc.symbol))
|
|
||||||
else:
|
|
||||||
vis.freeform(doc)
|
|
||||||
vis.write(output_dir)
|
|
||||||
|
|
@ -178,13 +178,6 @@ def ifcontext(ifcond, *args):
|
||||||
arg.end_if()
|
arg.end_if()
|
||||||
|
|
||||||
|
|
||||||
class QAPIGenDoc(QAPIGen):
|
|
||||||
|
|
||||||
def _top(self):
|
|
||||||
return (super()._top()
|
|
||||||
+ '@c AUTOMATICALLY GENERATED, DO NOT MODIFY\n\n')
|
|
||||||
|
|
||||||
|
|
||||||
class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor):
|
class QAPISchemaMonolithicCVisitor(QAPISchemaVisitor):
|
||||||
|
|
||||||
def __init__(self, prefix, what, blurb, pydoc):
|
def __init__(self, prefix, what, blurb, pydoc):
|
||||||
|
|
|
||||||
|
|
@ -1,313 +0,0 @@
|
||||||
@c AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
||||||
|
|
||||||
@section Section
|
|
||||||
|
|
||||||
@subsection Subsection
|
|
||||||
|
|
||||||
@strong{with emphasis}
|
|
||||||
@code{var} @{in braces@}
|
|
||||||
|
|
||||||
@itemize @bullet
|
|
||||||
@item
|
|
||||||
List item one
|
|
||||||
@item
|
|
||||||
Two, multiple
|
|
||||||
lines
|
|
||||||
|
|
||||||
@item
|
|
||||||
Three
|
|
||||||
Still in list
|
|
||||||
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
Not in list
|
|
||||||
|
|
||||||
@itemize @minus
|
|
||||||
@item
|
|
||||||
Second list
|
|
||||||
Note: still in list
|
|
||||||
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
Note: not in list
|
|
||||||
|
|
||||||
@enumerate
|
|
||||||
@item
|
|
||||||
Third list
|
|
||||||
is numbered
|
|
||||||
|
|
||||||
@item
|
|
||||||
another item
|
|
||||||
|
|
||||||
@end enumerate
|
|
||||||
|
|
||||||
Returns: the King
|
|
||||||
Since: the first age
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
@enumerate
|
|
||||||
@item
|
|
||||||
Lorem ipsum dolor sit amet
|
|
||||||
|
|
||||||
@item
|
|
||||||
Ut enim ad minim veniam
|
|
||||||
|
|
||||||
@end enumerate
|
|
||||||
|
|
||||||
Duis aute irure dolor
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
-> in
|
|
||||||
<- out
|
|
||||||
Examples:
|
|
||||||
@itemize @minus
|
|
||||||
@item
|
|
||||||
@strong{verbatim}
|
|
||||||
@item
|
|
||||||
@{braces@}
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Enum} Enum
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Values:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{one}
|
|
||||||
The @emph{one} @{and only@}
|
|
||||||
@*@b{If:} @code{defined(IFONE)}
|
|
||||||
@item @code{two}
|
|
||||||
Not documented
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{enum-feat}
|
|
||||||
Also @emph{one} @{and only@}
|
|
||||||
@end table
|
|
||||||
@code{two} is undocumented
|
|
||||||
|
|
||||||
@b{If:} @code{defined(IFCOND)}
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Object} Base
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Members:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{base1: Enum}
|
|
||||||
the first member
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Object} Variant1
|
|
||||||
|
|
||||||
A paragraph
|
|
||||||
|
|
||||||
Another paragraph (but no @code{var}: line)
|
|
||||||
|
|
||||||
@b{Members:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{var1: string}
|
|
||||||
Not documented
|
|
||||||
@*@b{If:} @code{defined(IFSTR)}
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{variant1-feat}
|
|
||||||
a feature
|
|
||||||
@item @code{member-feat}
|
|
||||||
a member feature
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Object} Variant2
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Object} Object
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Members:}
|
|
||||||
@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"} (@b{If:} @code{IFTWO})
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{union-feat1}
|
|
||||||
a feature
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Object} SugaredUnion
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Members:}
|
|
||||||
@table @asis
|
|
||||||
@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"} (@b{If:} @code{IFTWO})
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{union-feat2}
|
|
||||||
a feature
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftp {Alternate} Alternate
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Members:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{i: int}
|
|
||||||
an integer
|
|
||||||
@code{b} is undocumented
|
|
||||||
@item @code{b: boolean}
|
|
||||||
Not documented
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{alt-feat}
|
|
||||||
a feature
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftp
|
|
||||||
|
|
||||||
|
|
||||||
@subsection Another subsection
|
|
||||||
|
|
||||||
|
|
||||||
@deftypefn Command {} cmd
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Arguments:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{arg1: int}
|
|
||||||
the first argument
|
|
||||||
@item @code{arg2: string} (optional)
|
|
||||||
the second
|
|
||||||
argument
|
|
||||||
@item @code{arg3: boolean}
|
|
||||||
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
|
|
||||||
|
|
||||||
@b{Returns:}
|
|
||||||
@code{Object}
|
|
||||||
|
|
||||||
@b{TODO:}
|
|
||||||
frobnicate
|
|
||||||
|
|
||||||
@b{Notes:}
|
|
||||||
@itemize @minus
|
|
||||||
@item
|
|
||||||
Lorem ipsum dolor sit amet
|
|
||||||
@item
|
|
||||||
Ut enim ad minim veniam
|
|
||||||
|
|
||||||
@end itemize
|
|
||||||
|
|
||||||
Duis aute irure dolor
|
|
||||||
|
|
||||||
@b{Example:}
|
|
||||||
@example
|
|
||||||
-> in
|
|
||||||
<- out
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@b{Examples:}
|
|
||||||
@example
|
|
||||||
- *verbatim*
|
|
||||||
- @{braces@}
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@b{Since:}
|
|
||||||
2.10
|
|
||||||
|
|
||||||
@end deftypefn
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftypefn Command {} cmd-boxed
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
<- out
|
|
||||||
@end example
|
|
||||||
|
|
||||||
@end deftypefn
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@deftypefn Event {} EVT-BOXED
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@b{Arguments:} the members of @code{Object}
|
|
||||||
|
|
||||||
@b{Features:}
|
|
||||||
@table @asis
|
|
||||||
@item @code{feat3}
|
|
||||||
a feature
|
|
||||||
@end table
|
|
||||||
|
|
||||||
@end deftypefn
|
|
||||||
|
|
||||||
|
|
@ -206,8 +206,7 @@ test('QAPI schema regression tests', python, args: files('test-qapi.py', schemas
|
||||||
diff = find_program('diff')
|
diff = find_program('diff')
|
||||||
|
|
||||||
qapi_doc = custom_target('QAPI doc',
|
qapi_doc = custom_target('QAPI doc',
|
||||||
output: ['doc-good-qapi-doc.texi',
|
output: ['doc-good-qapi-commands.c', 'doc-good-qapi-commands.h',
|
||||||
'doc-good-qapi-commands.c', 'doc-good-qapi-commands.h',
|
|
||||||
'doc-good-qapi-emit-events.c', 'doc-good-qapi-emit-events.h',
|
'doc-good-qapi-emit-events.c', 'doc-good-qapi-emit-events.h',
|
||||||
'doc-good-qapi-events.c', 'doc-good-qapi-events.h',
|
'doc-good-qapi-events.c', 'doc-good-qapi-events.h',
|
||||||
'doc-good-qapi-init-commands.c', 'doc-good-qapi-init-commands.h',
|
'doc-good-qapi-init-commands.c', 'doc-good-qapi-init-commands.h',
|
||||||
|
|
@ -219,12 +218,6 @@ qapi_doc = custom_target('QAPI doc',
|
||||||
'-p', 'doc-good-', '@INPUT0@' ],
|
'-p', 'doc-good-', '@INPUT0@' ],
|
||||||
depend_files: qapi_gen_depends)
|
depend_files: qapi_gen_depends)
|
||||||
|
|
||||||
# "full_path()" needed here to work around
|
|
||||||
# https://github.com/mesonbuild/meson/issues/7585
|
|
||||||
test('QAPI doc', diff, args: ['-b', '-u', files('doc-good.texi'), qapi_doc[0].full_path()],
|
|
||||||
depends: qapi_doc,
|
|
||||||
suite: ['qapi-schema', 'qapi-doc'])
|
|
||||||
|
|
||||||
# Test the document-comment document generation code by running a test schema
|
# Test the document-comment document generation code by running a test schema
|
||||||
# file through Sphinx's plain-text builder and comparing the result against
|
# file through Sphinx's plain-text builder and comparing the result against
|
||||||
# a golden reference. This is in theory susceptible to failures if Sphinx
|
# a golden reference. This is in theory susceptible to failures if Sphinx
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue