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/qapi.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/qapi.py')
| -rw-r--r-- | scripts/qapi.py | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/scripts/qapi.py b/scripts/qapi.py index f4c82100f4..fb10d937aa 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -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]) |