aboutsummaryrefslogtreecommitdiff
path: root/qapi/char.json
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2020-02-13 17:56:33 +0000
committerMarkus Armbruster <armbru@redhat.com>2020-02-15 11:41:50 +0100
commit100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d (patch)
tree75db75f3625cd9339078a15ff8ac4d31d7bc88b4 /qapi/char.json
parente050e426782ec4ae6bf84e5ec75ca502187f69cb (diff)
downloadqemu-100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d.zip
qemu-100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d.tar.gz
qemu-100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d.tar.bz2
qapi: Add blank lines before bulleted lists
We would like to switch the doc comments to rST format. rST insists on a blank line before and after a bulleted list, but our Texinfo doc generator did not. Add some extra blank lines in the doc comments so they're acceptable rST input. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-Id: <20200213175647.17628-17-peter.maydell@linaro.org> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Commit message tweaked] Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/char.json')
-rw-r--r--qapi/char.json2
1 files changed, 2 insertions, 0 deletions
diff --git a/qapi/char.json b/qapi/char.json
index 8a9f1e7..6907b2b 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -133,6 +133,7 @@
# @data: data to write
#
# @format: data encoding (default 'utf8').
+#
# - base64: data must be base64 encoded text. Its binary
# decoding gets written.
# - utf8: data's UTF-8 encoding is written
@@ -167,6 +168,7 @@
# @size: how many bytes to read at most
#
# @format: data encoding (default 'utf8').
+#
# - base64: the data read is returned in base64 encoding.
# - utf8: the data read is interpreted as UTF-8.
# Bug: can screw up when the buffer contains invalid UTF-8