qemu/scripts/qapi
Markus Armbruster dcdc07a97c qapi: Make section headings start a new doc comment block
Our current QAPI doc-comment markup allows section headers (introduced
with a leading '=' or '==') anywhere in a free-form documentation
comment.  This works for Texinfo because the generator simply prints a
Texinfo section command at that point in the output stream.  For rST
generation, since we're assembling a tree of docutils nodes, this is
awkward because a new section implies starting a new section node at
the top level of the tree and generating text into there.

Make section headers start a new free-form documentation block, so the
future rST document generator doesn't have to look at every line in
free-form blocks and handle headings in odd places.

This change makes no difference to the generated Texinfo.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200320091805.5585-3-armbru@redhat.com>
2020-09-07 16:35:16 +02:00
..
__init__.py qapi-gen: New common driver for code and doc generators 2018-03-02 13:14:09 -06:00
commands.py qapi: Smooth visitor error checking in generated code 2020-07-10 15:18:08 +02:00
common.py qapi: Drop conditionals for Python 2 2020-03-05 09:24:11 +01:00
doc.py qapi: Consistently put @features parameter right after @ifcond 2020-03-17 19:58:34 +01:00
error.py qapi: Use super() now we have Python 3 2020-03-05 09:24:11 +01:00
events.py qapi: Add feature flags to remaining definitions 2020-03-17 19:58:34 +01:00
expr.py qapi: Add feature flags to struct members 2020-03-17 21:25:47 +01:00
gen.py qemu-storage-daemon: Add --monitor option 2020-03-06 17:21:28 +01:00
introspect.py qapi: Add feature flags to struct members 2020-03-17 21:25:47 +01:00
parser.py qapi: Make section headings start a new doc comment block 2020-09-07 16:35:16 +02:00
schema.py qapi: New special feature flag "deprecated" 2020-03-17 21:42:47 +01:00
source.py qapi: Inheriting from object is pointless with Python 3, drop 2020-03-05 09:24:11 +01:00
types.py qapi: enable use of g_autoptr with QAPI types 2020-09-03 09:38:36 +02:00
visit.py qapi: Fix visit_type_STRUCT() not to fail for null object 2020-07-21 14:38:23 +02:00