[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 04/30] qmp-commands: move 'query-status' doc to sche
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH 04/30] qmp-commands: move 'query-status' doc to schema |
Date: |
Tue, 13 Sep 2016 17:01:43 +0400 |
Signed-off-by: Marc-André Lureau <address@hidden>
---
docs/qmp-commands.txt | 31 -------------------------------
qapi-schema.json | 10 ++++++++--
2 files changed, 8 insertions(+), 33 deletions(-)
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index 2e78d60..6f6db87 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -2388,37 +2388,6 @@ Example:
Note: This example has been shortened as the real response is too long.
-query-status
-------------
-
-Return a json-object with the following information:
-
-- "running": true if the VM is running, or false if it is paused (json-bool)
-- "singlestep": true if the VM is in single step mode,
- false otherwise (json-bool)
-- "status": one of the following values (json-string)
- "debug" - QEMU is running on a debugger
- "inmigrate" - guest is paused waiting for an incoming migration
- "internal-error" - An internal error that prevents further guest
- execution has occurred
- "io-error" - the last IOP has failed and the device is configured
- to pause on I/O errors
- "paused" - guest has been paused via the 'stop' command
- "postmigrate" - guest is paused following a successful 'migrate'
- "prelaunch" - QEMU was started with -S and guest has not started
- "finish-migrate" - guest is paused to finish the migration process
- "restore-vm" - guest is paused to restore VM state
- "running" - guest is actively running
- "save-vm" - guest is paused to save the VM state
- "shutdown" - guest is shut down (and -no-shutdown is in use)
- "watchdog" - the watchdog action is configured to pause and
- has been triggered
-
-Example:
-
--> { "execute": "query-status" }
-<- { "return": { "running": true, "singlestep": false, "status": "running" } }
-
query-mice
----------
diff --git a/qapi-schema.json b/qapi-schema.json
index b013b39..008a7f9 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -205,7 +205,7 @@
##
# @StatusInfo:
#
-# Information about VCPU run state
+# Information about VCPU run state.
#
# @running: true if all VCPUs are runnable, false if not runnable
#
@@ -223,11 +223,17 @@
##
# @query-status:
#
-# Query the run status of all VCPUs
+# Query the run status of all VCPUs.
#
# Returns: @StatusInfo reflecting all VCPUs
#
# Since: 0.14.0
+#
+# Example:
+#
+# -> { "execute": "query-status" }
+# <- { "return": { "running": true, "singlestep": false, "status": "running" }
}
+#
##
{ 'command': 'query-status', 'returns': 'StatusInfo' }
--
2.10.0
- [Qemu-devel] [PATCH 00/30] Move qapi documentation to schema (part 1/5), Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 01/30] qmp-commands: move 'add_client' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 02/30] qmp-commands: move 'query-name' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 03/30] qmp-commands: move 'query-kvm' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 05/30] qmp-commands: move 'query-uuid' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 04/30] qmp-commands: move 'query-status' doc to schema,
Marc-André Lureau <=
- [Qemu-devel] [PATCH 06/30] qmp-commands: move 'query-chardev' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 07/30] qmp-commands: move 'query-chardev-backends' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 08/30] qmp-commands: move 'ringbuf-write' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 09/30] qmp-commands: move 'ringbuf-read' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 11/30] qmp-commands: move 'query-migrate' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 10/30] qmp-commands: move 'query-events' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 12/30] qmp-commands: move 'migrate-set-capabilities' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 13/30] qmp-commands: move 'query-migrate-capabilities' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 14/30] qmp-commands: move 'migrate-set-parameters' doc to schema, Marc-André Lureau, 2016/09/13