diff options
| author | Markus Armbruster <armbru@redhat.com> | 2017-10-02 16:13:37 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-12-20 19:18:33 +0100 |
| commit | fc3f0df18711121ddbcd04bac3a6abb3fb9392be (patch) | |
| tree | 53efac755ea5b432183713d9243291f43857294c | |
| parent | 0968dc9ae4d3f309c4ab4bddc2a69c8d9b2786ae (diff) | |
| download | qemu-fc3f0df18711121ddbcd04bac3a6abb3fb9392be.zip qemu-fc3f0df18711121ddbcd04bac3a6abb3fb9392be.tar.gz qemu-fc3f0df18711121ddbcd04bac3a6abb3fb9392be.tar.bz2 | |
qapi: Unify representation of doc section without name
We have two representations of sections without a name: the main
section uses name=None, the others name=''. Standardize on name=None.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20171002141341.24616-8-armbru@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
| -rw-r--r-- | scripts/qapi.py | 2 | ||||
| -rwxr-xr-x | scripts/qapi2texi.py | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-bad-section.out | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 2 |
4 files changed, 4 insertions, 4 deletions
diff --git a/scripts/qapi.py b/scripts/qapi.py index 2f2738f..2137067 100644 --- a/scripts/qapi.py +++ b/scripts/qapi.py @@ -204,7 +204,7 @@ class QAPIDoc(object): self.section = QAPIDoc.ArgSection(name) self.args[name] = self.section - def _start_section(self, name=''): + def _start_section(self, name=None): if name in ('Returns', 'Since') and self.has_section(name): raise QAPIParseError(self.parser, "Duplicated '%s' section" % name) diff --git a/scripts/qapi2texi.py b/scripts/qapi2texi.py index f876d9a..f16fa1b 100755 --- a/scripts/qapi2texi.py +++ b/scripts/qapi2texi.py @@ -184,7 +184,7 @@ def texi_sections(doc): # prefer @b over @strong, so txt doesn't translate it to *Foo:* body += '\n\n@b{%s:}\n' % section.name text = str(section) - if section.name.startswith('Example'): + if section.name and section.name.startswith('Example'): body += texi_example(text) else: body += texi_format(text) diff --git a/tests/qapi-schema/doc-bad-section.out b/tests/qapi-schema/doc-bad-section.out index 6fce84d..089bde1 100644 --- a/tests/qapi-schema/doc-bad-section.out +++ b/tests/qapi-schema/doc-bad-section.out @@ -9,5 +9,5 @@ doc symbol=Enum The _one_ {and only} arg=two - section= + section=None @two is undocumented diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index c55e394..1d2c250 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -82,7 +82,7 @@ doc symbol=Enum The _one_ {and only} arg=two - section= + section=None @two is undocumented doc symbol=Base body= |