diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-03-15 13:57:00 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-03-16 07:13:02 +0100 |
| commit | b116fd8e302d0ff7cabf431e78ce078127b51f85 (patch) | |
| tree | 9ef95b8e68ce9ae58b0e079cc4e9adcb6cf932e9 /scripts/qapi2texi.py | |
| parent | 42bebcc129a8bf235f41d65788eb54e199ba5e64 (diff) | |
qapi: Avoid unwanted blank lines in QAPIDoc
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>
Diffstat (limited to 'scripts/qapi2texi.py')
| -rwxr-xr-x | scripts/qapi2texi.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index 0f3e5738c8..0aaf45c98c 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -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, |