aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2020-03-20 10:18:04 +0100
committerMarkus Armbruster <armbru@redhat.com>2020-09-07 16:35:16 +0200
commitd98884b75df3676f94d93fbaf6372ca705dc2aee (patch)
tree3e48c319caecf6908c92f5ed11458a53b44f932b /docs
parent62f9256052df85194faa33137bbe0afb1c95b6e6 (diff)
downloadqemu-d98884b75df3676f94d93fbaf6372ca705dc2aee.zip
qemu-d98884b75df3676f94d93fbaf6372ca705dc2aee.tar.gz
qemu-d98884b75df3676f94d93fbaf6372ca705dc2aee.tar.bz2
qapi: Reject section markup in definition documentation
Section markup in definition documentation makes no sense and can produce invalid Texinfo. Reject. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-Id: <20200320091805.5585-2-armbru@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/devel/qapi-code-gen.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/devel/qapi-code-gen.txt b/docs/devel/qapi-code-gen.txt
index f3e7ced..9eede44 100644
--- a/docs/devel/qapi-code-gen.txt
+++ b/docs/devel/qapi-code-gen.txt
@@ -835,6 +835,8 @@ Double the '=' for a subsection title:
# == Subsection title
+Both are only permitted in free-form documentation.
+
'|' denotes examples:
# | Text of the example, may span