[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 07/13] qapi: Unify representation of doc section with
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 07/13] qapi: Unify representation of doc section without name |
Date: |
Wed, 20 Dec 2017 19:59:18 +0100 |
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 <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
---
scripts/qapi.py | 2 +-
scripts/qapi2texi.py | 2 +-
tests/qapi-schema/doc-bad-section.out | 2 +-
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 2f2738f562..2137067b48 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 f876d9a174..f16fa1ba53 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 += 'address@hidden:}\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 6fce84dd34..089bde1381 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 c55e394e8a..1d2c250527 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=
--
2.13.6
- [Qemu-devel] [PULL 00/13] QAPI patches for 2017-12-20, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 03/13] qapi: Eliminate QAPISchemaParser.__init__()'s local fname, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 07/13] qapi: Unify representation of doc section without name,
Markus Armbruster <=
- [Qemu-devel] [PULL 10/13] qapi: Rename QAPIDoc.parser, .section to ._parser, ._section, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 09/13] qapi2texi: Simplify representation of section text, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 06/13] qapi2texi: Clean up texi_sections(), Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 04/13] qapi: Make cur_doc local to QAPISchemaParser.__init__(), Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 12/13] qapi-docs: fix a comment typo, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 08/13] qapi: Simplify representation of QAPIDoc section text, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 02/13] qapi: Stop rejecting #optional, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 01/13] qapi-schema: Fix query-vm-generation-id's doc comment markup, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 11/13] qapi2texi: De-duplicate code to add blank line before symbol, Markus Armbruster, 2017/12/20
- [Qemu-devel] [PULL 05/13] tests/qapi-schema/doc-bad-section: New, factored out of doc-good, Markus Armbruster, 2017/12/20