Skip to content

Commit

Permalink
qmp-commands: move 'human-monitor-command' doc to schema
Browse files Browse the repository at this point in the history
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
  • Loading branch information
elmarco authored and Markus Armbruster committed Jan 16, 2017
1 parent 5c82b0f commit e9ac76a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 34 deletions.
33 changes: 0 additions & 33 deletions docs/qmp-commands.txt
Expand Up @@ -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
=================

Expand Down
13 changes: 12 additions & 1 deletion qapi-schema.json
Expand Up @@ -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:
#
Expand All @@ -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'},
Expand Down

0 comments on commit e9ac76a

Please sign in to comment.