motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-07 17:53:56 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

qapi: Make section headings start a new doc comment block

Browse source 
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>
This commit is contained in:
Markus Armbruster 2020-03-20 10:18:05 +01:00
parent d98884b75d
commit dcdc07a97c
2 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

3
tests/qapi-schema/doc-good.out
View file

@ -69,7 +69,8 @@ event EVT-BOXED Object
doc freeform
body=
= Section
doc freeform
body=
== Subsection
*strong* _with emphasis_