aboutsummaryrefslogtreecommitdiff
path: root/qapi-schema.json
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-06-23 13:15:03 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-01-16 09:15:28 +0100
commite9ac76acd7aed4d96d05a6abf1460dd63afec20f (patch)
tree48bf7a0c0f3544e13e7b75619afe4c3b14b6c1d9 /qapi-schema.json
parent5c82b0f1982932b494ccb1c35a96b7db1db444f9 (diff)
qmp-commands: move 'human-monitor-command' 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.json13
1 files changed, 12 insertions, 1 deletions
diff --git a/qapi-schema.json b/qapi-schema.json
index 330ccfad4d..f3d2c4260e 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -2552,7 +2552,11 @@
# Since: 0.14.0
#
# Notes: This command only exists as a stop-gap. Its use is highly
-# discouraged. The semantics of this command are not guaranteed.
+# discouraged. The semantics of this command are not
+# guaranteed: this means that command names, arguments and
+# responses can change or be removed at ANY time. Applications
+# that rely on long term stability guarantees should NOT
+# use this command.
#
# Known limitations:
#
@@ -2561,6 +2565,13 @@
#
# * Commands that prompt the user for data (eg. 'cont' when the block
# device is encrypted) don't currently work
+#
+# Example:
+#
+# -> { "execute": "human-monitor-command",
+# "arguments": { "command-line": "info kvm" } }
+# <- { "return": "kvm support: enabled\r\n" }
+#
##
{ 'command': 'human-monitor-command',
'data': {'command-line': 'str', '*cpu-index': 'int'},