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

qapi: Avoid unwanted blank lines in QAPIDoc

Browse source 
We silently fix missing #optional tags for QAPIDoc by appending a line
"#optional" to the section's .content.  However, this interferes with
.__repr__ stripping trailing blank lines from .content.

Use new ArgSection instance variable .optional instead, and leave
.content alone.

To permit testing .optional in texi_body(), clean up texi_enum()'s
hack to add empty documentation for undocumented enum values: add an
ArgSection instead of ''.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1489582656-31133-12-git-send-email-armbru@redhat.com>
This commit is contained in:
Markus Armbruster 2017-03-15 13:57:00 +01:00
parent 42bebcc129
commit b116fd8e30
2 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

4
scripts/qapi2texi.py
View file

@ -136,7 +136,7 @@ def texi_body(doc):
for arg, section in doc.args.iteritems():
desc = str(section)
opt = ''
if "#optional" in desc:
if section.optional:
desc = re.sub(r'^ *#optional *\n?|\n? *#optional *$|#optional',
'', desc)
opt = ' (optional)'
@ -185,7 +185,7 @@ def texi_enum(expr, doc):
"""Format an enum to texi"""
for i in expr['data']:
if i not in doc.args:
doc.args[i] = ''
doc.args[i] = qapi.QAPIDoc.ArgSection(i)
body = texi_body(doc)
return TYPE_FMT(type="Enum",
name=doc.symbol,