Skip to content

Commit

Permalink
qmp-commands: move 'eject' 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 b31177b commit 5fba0a7
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 21 deletions.
19 changes: 0 additions & 19 deletions docs/qmp-commands.txt
Expand Up @@ -53,25 +53,6 @@ If you're planning to adopt QMP, please observe the following:
Server's responses in the examples below are always a success response, please
refer to the QMP specification for more details on error responses.

eject
-----

Eject a removable medium.

Arguments:

- "force": force ejection (json-bool, optional)
- "device": block device name (deprecated, use @id instead)
(json-string, optional)
- "id": the name or QOM path of the guest device (json-string, optional)

Example:

-> { "execute": "eject", "arguments": { "id": "ide0-1-0" } }
<- { "return": {} }

Note: The "force" argument defaults to false.

device_add
----------

Expand Down
10 changes: 8 additions & 2 deletions qapi/block.json
Expand Up @@ -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',
Expand Down

0 comments on commit 5fba0a7

Please sign in to comment.