[Qemu-devel] [PATCH 09/30] qmp-commands: move 'ringbuf-read' doc to schema

[Marc-André Lureau]

Signed-off-by: Marc-André Lureau <address@hidden>
---
 docs/qmp-commands.txt | 27 ---------------------------
 qapi-schema.json      |  9 +++++++++
 2 files changed, 9 insertions(+), 27 deletions(-)

diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index 44a7632..4d1907a 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -332,33 +332,6 @@ Example:
 
 Note: inject-nmi fails when the guest doesn't support injecting.
 
-ringbuf-read
--------------
-
-Read from a ring buffer character device.
-
-Arguments:
-
-- "device": ring buffer character device name (json-string)
-- "size": how many bytes to read at most (json-int)
-          - Number of data bytes, not number of characters in encoded data
-- "format": data format (json-string, optional)
-          - Possible values: "utf8" (default), "base64"
-          - Naturally, format "utf8" works only when the ring buffer
-            contains valid UTF-8 text.  Invalid UTF-8 sequences get
-            replaced.  Bug: replacement doesn't work.  Bug: can screw
-            up on encountering NUL characters, after the ring buffer
-            lost data, and when reading stops because the size limit
-            is reached.
-
-Example:
-
--> { "execute": "ringbuf-read",
-                "arguments": { "device": "foo",
-                               "size": 1000,
-                               "format": "utf8" } }
-<- {"return": "abcdefgh"}
-
 xen-save-devices-state
 -------
 
diff --git a/qapi-schema.json b/qapi-schema.json
index c23c0cb..45aa6b8 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -436,6 +436,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'},
-- 
2.10.0