diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2016-06-23 13:15:03 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:15:28 +0100 |
| commit | e9ac76acd7aed4d96d05a6abf1460dd63afec20f (patch) | |
| tree | 48bf7a0c0f3544e13e7b75619afe4c3b14b6c1d9 | |
| parent | 5c82b0f1982932b494ccb1c35a96b7db1db444f9 (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>
| -rw-r--r-- | docs/qmp-commands.txt | 33 | ||||
| -rw-r--r-- | qapi-schema.json | 13 |
2 files changed, 12 insertions, 34 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index eee7f253d7..3faba0cbc4 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -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 ================= 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'}, |