summary refs log tree commit diff stats
path: root/scripts/qapi-gen.py
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2020-09-25 17:23:05 +0100
committerMarkus Armbruster <armbru@redhat.com>2020-09-29 17:55:39 +0200
commita0fcff383b34f908efe05d4037e2c948abf6b38d (patch)
tree2e4bba3341beecc576b53690b8ee1d207117be61 /scripts/qapi-gen.py
parent4ac2ee194bc5290ea1e9015e5be31a05688a8663 (diff)
downloadfocaccia-qemu-a0fcff383b34f908efe05d4037e2c948abf6b38d.tar.gz
focaccia-qemu-a0fcff383b34f908efe05d4037e2c948abf6b38d.zip
qapi: Use rST markup for literal blocks
There are exactly two places in our json doc comments where we
use the markup accepted by the texi doc generator where a '|' in
the first line of a doc comment means the line should be emitted
as a literal block (fixed-width font, whitespace preserved).

Since we use this syntax so rarely, instead of making the rST
generator support it, instead just convert the two uses to
rST-format literal blocks, which are indented and introduced
with '::'.

(The rST generator doesn't complain about the old style syntax,
it just emits it with the '|' and with the whitespace not
preserved, which looks odd, but means we can safely leave this
change until after we've stopped generating texinfo.)

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-11-peter.maydell@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'scripts/qapi-gen.py')
0 files changed, 0 insertions, 0 deletions