[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 09/13] qapi2texi: Simplify representation of section
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 09/13] qapi2texi: Simplify representation of section text |
Date: |
Wed, 20 Dec 2017 19:59:20 +0100 |
Use a string instead of a list of strings. While there, generate
fewer superfluous blank lines.
Signed-off-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
---
scripts/qapi2texi.py | 33 ++++++++++++++++-----------------
tests/qapi-schema/doc-good.texi | 10 ----------
2 files changed, 16 insertions(+), 27 deletions(-)
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py
index 379d27643d..58add26c11 100755
--- a/scripts/qapi2texi.py
+++ b/scripts/qapi2texi.py
@@ -13,7 +13,6 @@ MSG_FMT = """
@deftypefn {type} {{}} {name}
{body}
-
@end deftypefn
""".format
@@ -22,7 +21,6 @@ TYPE_FMT = """
@deftp {{{type}}} {name}
{body}
-
@end deftp
""".format
@@ -74,7 +72,7 @@ def texi_format(doc):
- 1. or 1): generates an @enumerate @item
- */-: generates an @itemize list
"""
- lines = []
+ ret = ''
doc = subst_braces(doc)
doc = subst_vars(doc)
doc = subst_emph(doc)
@@ -100,32 +98,32 @@ def texi_format(doc):
line = '@subsection ' + line[3:]
elif re.match(r'^([0-9]*\.) ', line):
if not inlist:
- lines.append('@enumerate')
+ ret += '@enumerate\n'
inlist = 'enumerate'
+ ret += '@item\n'
line = line[line.find(' ')+1:]
- lines.append('@item')
elif re.match(r'^[*-] ', line):
if not inlist:
- lines.append('@itemize %s' % {'*': '@bullet',
- '-': '@minus'}[line[0]])
+ ret += '@itemize %s\n' % {'*': '@bullet',
+ '-': '@minus'}[line[0]]
inlist = 'itemize'
- lines.append('@item')
+ ret += '@item\n'
line = line[2:]
elif lastempty and inlist:
- lines.append('@end %s\n' % inlist)
+ ret += '@end %s\n\n' % inlist
inlist = ''
lastempty = empty
- lines.append(line)
+ ret += line + '\n'
if inlist:
- lines.append('@end %s\n' % inlist)
- return '\n'.join(lines)
+ ret += '@end %s\n\n' % inlist
+ return ret
def texi_body(doc):
"""Format the main documentation body"""
- return texi_format(doc.body.text) + '\n'
+ return texi_format(doc.body.text)
def texi_enum_value(value):
@@ -154,10 +152,11 @@ def texi_members(doc, what, base, variants, member_func):
elif (variants and variants.tag_member == section.member
and not section.member.type.doc_type()):
values = section.member.type.member_names()
- desc = 'One of ' + ', '.join(['@t{"%s"}' % v for v in values])
+ members_text = ', '.join(['@t{"%s"}' % v for v in values])
+ desc = 'One of ' + members_text + '\n'
else:
- desc = 'Not documented'
- items += member_func(section.member) + desc + '\n'
+ desc = 'Not documented\n'
+ items += member_func(section.member) + desc
if base:
items += '@item The members of @code{%s}\n' % base.doc_type()
if variants:
@@ -182,7 +181,7 @@ def texi_sections(doc):
for section in doc.sections:
if section.name:
# prefer @b over @strong, so txt doesn't translate it to *Foo:*
- body += 'address@hidden:}\n' % section.name
+ body += 'address@hidden:}\n' % section.name
if section.name and section.name.startswith('Example'):
body += texi_example(section.text)
else:
diff --git a/tests/qapi-schema/doc-good.texi b/tests/qapi-schema/doc-good.texi
index c032f23fc1..1778312581 100644
--- a/tests/qapi-schema/doc-good.texi
+++ b/tests/qapi-schema/doc-good.texi
@@ -101,7 +101,6 @@ Not documented
the first member
@end table
-
@end deftp
@@ -118,7 +117,6 @@ Another paragraph (but no @code{var}: line)
Not documented
@end table
-
@end deftp
@@ -127,7 +125,6 @@ Not documented
-
@end deftp
@@ -143,7 +140,6 @@ Not documented
@item The members of @code{Variant2} when @code{base1} is @t{"two"}
@end table
-
@end deftp
@@ -160,7 +156,6 @@ One of @t{"one"}, @t{"two"}
@item @code{data: Variant2} when @code{type} is @t{"two"}
@end table
-
@end deftp
@@ -182,7 +177,6 @@ argument
Not documented
@end table
-
@b{Note:}
@code{arg3} is undocumented
@@ -209,14 +203,12 @@ Duis aute irure dolor
<- out
@end example
-
@b{Examples:}
@example
- *verbatim*
- @address@hidden
@end example
-
@b{Since:}
2.10
@@ -230,7 +222,6 @@ If you're bored enough to read this, go see a video of
boxed cats
@b{Arguments:} the members of @code{Object}
-
@b{Example:}
@example
-> in
@@ -238,7 +229,6 @@ If you're bored enough to read this, go see a video of
boxed cats
<- out
@end example
-
@end deftypefn
--
2.13.6
- [Qemu-devel] [PULL 00/13] QAPI patches for 2017-12-20, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 03/13] qapi: Eliminate QAPISchemaParser.__init__()'s local fname, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 07/13] qapi: Unify representation of doc section without name, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 10/13] qapi: Rename QAPIDoc.parser, .section to ._parser, ._section, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 09/13] qapi2texi: Simplify representation of section text,
Markus Armbruster <=
- [Qemu-devel] [PULL 06/13] qapi2texi: Clean up texi_sections(), Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 04/13] qapi: Make cur_doc local to QAPISchemaParser.__init__(), Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 12/13] qapi-docs: fix a comment typo, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 08/13] qapi: Simplify representation of QAPIDoc section text, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 02/13] qapi: Stop rejecting #optional, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 01/13] qapi-schema: Fix query-vm-generation-id's doc comment markup, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 11/13] qapi2texi: De-duplicate code to add blank line before symbol, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 05/13] tests/qapi-schema/doc-bad-section: New, factored out of doc-good, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 13/13] qmp: remove qmp_cpu, Markus Armbruster, 2017/12/20
- Re: [Qemu-devel] [PULL 00/13] QAPI patches for 2017-12-20, Peter Maydell, 2017/12/20