mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-07-27 04:13:53 -06:00
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>
This commit is contained in:
parent
42bebcc129
commit
b116fd8e30
2 changed files with 5 additions and 4 deletions
|
@ -107,6 +107,7 @@ class QAPIDoc(object):
|
|||
self.name = name
|
||||
# the list of lines for this section
|
||||
self.content = []
|
||||
self.optional = False
|
||||
|
||||
def append(self, line):
|
||||
self.content.append(line)
|
||||
|
@ -982,15 +983,15 @@ def check_definition_doc(doc, expr, info):
|
|||
desc = doc.args.get(arg)
|
||||
if not desc:
|
||||
continue
|
||||
desc.optional = opt
|
||||
desc_opt = "#optional" in str(desc)
|
||||
if desc_opt and not opt:
|
||||
raise QAPISemError(info, "Description has #optional, "
|
||||
"but the declaration doesn't")
|
||||
if not desc_opt and opt:
|
||||
# silently fix the doc
|
||||
# TODO either fix the schema and make this an error,
|
||||
# or drop #optional entirely
|
||||
desc.append("#optional")
|
||||
pass
|
||||
|
||||
doc_args = set(doc.args.keys())
|
||||
args = set([name.strip('*') for name in args])
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue