aboutsummaryrefslogtreecommitdiff
path: root/qapi-schema.json
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-06-23 10:15:59 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-01-16 09:15:26 +0100
commit4f19a01b3e066b56bf22d83ff12d840c9a213dff (patch)
treede268c44865d0fb4b0607598313821731d9f1923 /qapi-schema.json
parenta4143a845a6d4b078b34aa3c750566cfdea6192a (diff)
qmp-commands: move 'ringbuf-read' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi-schema.json')
-rw-r--r--qapi-schema.json9
1 files changed, 9 insertions, 0 deletions
diff --git a/qapi-schema.json b/qapi-schema.json
index cff9ae25ed..dfd3299774 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -446,6 +446,15 @@
# Returns: data read from the device
#
# Since: 1.4
+#
+# Example:
+#
+# -> { "execute": "ringbuf-read",
+# "arguments": { "device": "foo",
+# "size": 1000,
+# "format": "utf8" } }
+# <- { "return": "abcdefgh" }
+#
##
{ 'command': 'ringbuf-read',
'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},