qmp-commands: move 'human-monitor-command' doc to schema
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Thu, 23 Jun 2016 11:15:03 +0000 (13:15 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 16 Jan 2017 08:15:28 +0000 (09:15 +0100)
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
docs/qmp-commands.txt
qapi-schema.json

index eee7f253d7a029bdab85d4ee8b28e5df5e528998..3faba0cbc4b8ca20e4a35f3c892257f72bdc94fb 100644 (file)
@@ -1228,39 +1228,6 @@ Example:
 
 Note: This command must be issued before issuing any other command.
 
-human-monitor-command
----------------------
-
-Execute a Human Monitor command.
-
-Arguments:
-
-- command-line: the command name and its arguments, just like the
-                Human Monitor's shell (json-string)
-- cpu-index: select the CPU number to be used by commands which access CPU
-             data, like 'info registers'. The Monitor selects CPU 0 if this
-             argument is not provided (json-int, optional)
-
-Example:
-
--> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
-<- { "return": "kvm support: enabled\r\n" }
-
-Notes:
-
-(1) The Human Monitor is NOT an stable interface, 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
-
-(2) Limitations:
-
-    o This command is stateless, this means that commands that depend
-      on state information (such as getfd) might not work
-
-    o Commands that prompt the user for data (eg. 'cont' when the block
-      device is encrypted) don't currently work
-
 3. Query Commands
 =================
 
index 330ccfad4d6d125324454445e29e5da0b75c6770..f3d2c4260e620570f7d3b03d1257b1c3fd5a663f 100644 (file)
 # 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:
 #
 #
 #        * 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'},