From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Subject: [Qemu-devel] [PULL 07/13] qapi: Unify representation of doc section without name
Date: Wed, 20 Dec 2017 19:59:18 +0100 [thread overview]
Message-ID: <20171220185924.32756-8-armbru@redhat.com> (raw)
In-Reply-To: <20171220185924.32756-1-armbru@redhat.com>
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>
---
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 += '\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 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
next prev parent reply other threads:[~2017-12-20 18:59 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-20 18:59 [Qemu-devel] [PULL 00/13] QAPI patches for 2017-12-20 Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 01/13] qapi-schema: Fix query-vm-generation-id's doc comment markup Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 02/13] qapi: Stop rejecting #optional Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 03/13] qapi: Eliminate QAPISchemaParser.__init__()'s local fname Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 04/13] qapi: Make cur_doc local to QAPISchemaParser.__init__() Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 05/13] tests/qapi-schema/doc-bad-section: New, factored out of doc-good Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 06/13] qapi2texi: Clean up texi_sections() Markus Armbruster
2017-12-20 18:59 ` Markus Armbruster [this message]
2017-12-20 18:59 ` [Qemu-devel] [PULL 08/13] qapi: Simplify representation of QAPIDoc section text Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 09/13] qapi2texi: Simplify representation of " Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 10/13] qapi: Rename QAPIDoc.parser, .section to ._parser, ._section Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 11/13] qapi2texi: De-duplicate code to add blank line before symbol Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 12/13] qapi-docs: fix a comment typo Markus Armbruster
2017-12-20 18:59 ` [Qemu-devel] [PULL 13/13] qmp: remove qmp_cpu Markus Armbruster
2017-12-20 22:17 ` [Qemu-devel] [PULL 00/13] QAPI patches for 2017-12-20 Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171220185924.32756-8-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).