aboutsummaryrefslogtreecommitdiff
path: root/qapi/block.json
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-06-23 15:08:55 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-01-16 09:19:46 +0100
commit5fba0a72ec1968debca8bb80732cc75aa7cd8a21 (patch)
tree9805c49bcdb7c7de37def148d96136b95fdd5211 /qapi/block.json
parentb31177b028c7f2f5e84f267b40802118476a7645 (diff)
downloadqemu-5fba0a72ec1968debca8bb80732cc75aa7cd8a21.zip
qemu-5fba0a72ec1968debca8bb80732cc75aa7cd8a21.tar.gz
qemu-5fba0a72ec1968debca8bb80732cc75aa7cd8a21.tar.bz2
qmp-commands: move 'eject' 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/block.json')
-rw-r--r--qapi/block.json10
1 files changed, 8 insertions, 2 deletions
diff --git a/qapi/block.json b/qapi/block.json
index bc27e20..6f57d70 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -167,15 +167,21 @@
#
# @id: #optional The name or QOM path of the guest device (since: 2.8)
#
-# @force: @optional If true, eject regardless of whether the drive is locked.
+# @force: #optional If true, eject regardless of whether the drive is locked.
# If not specified, the default value is false.
#
# Returns: Nothing on success
+#
# If @device is not a valid block device, DeviceNotFound
#
-# Notes: Ejecting a device will no media results in success
+# Notes: Ejecting a device with no media results in success
#
# Since: 0.14.0
+#
+# Example:
+#
+# -> { "execute": "eject", "arguments": { "device": "ide1-0-1" } }
+# <- { "return": {} }
##
{ 'command': 'eject',
'data': { '*device': 'str',