motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-07-27 20:33:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Simplify representation of QAPIDoc section text

Browse source 
Use a string instead of a list of strings.

This makes qapi2texi.py generate additional blank lines.  They're
harmless, and the next commit will get rid of them again.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20171002141341.24616-9-armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
This commit is contained in:
Markus Armbruster 2017-10-02 16:13:38 +02:00
parent fc3f0df187
commit 09331fced1
4 changed files with 17 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

14
scripts/qapi2texi.py
View file

@ -125,7 +125,7 @@ def texi_format(doc):
def texi_body(doc):
"""Format the main documentation body"""
return texi_format(str(doc.body)) + '\n'
return texi_format(doc.body.text) + '\n'
def texi_enum_value(value):
@ -149,8 +149,8 @@ def texi_members(doc, what, base, variants, member_func):
items = ''
for section in doc.args.itervalues():
# TODO Drop fallbacks when undocumented members are outlawed
if section.content:
desc = texi_format(str(section))
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()
@ -183,11 +183,10 @@ def texi_sections(doc):
if section.name:
# prefer @b over @strong, so txt doesn't translate it to *Foo:*
body += '\n\n@b{%s:}\n' % section.name
text = str(section)
if section.name and section.name.startswith('Example'):
body += texi_example(text)
body += texi_example(section.text)
else:
body += texi_format(text)
body += texi_format(section.text)
return body
@ -240,7 +239,8 @@ class QAPISchemaGenDocVisitor(qapi.QAPISchemaVisitor):
self.out += '\n'
if boxed:
body = texi_body(doc)
body += '\n@b{Arguments:} the members of @code{%s}' % arg_type.name
body += ('\n@b{Arguments:} the members of @code{%s}\n'
% arg_type.name)
body += texi_sections(doc)
else:
body = texi_entity(doc, 'Arguments')