diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2016-06-23 15:08:55 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:19:46 +0100 |
| commit | 5fba0a72ec1968debca8bb80732cc75aa7cd8a21 (patch) | |
| tree | 9805c49bcdb7c7de37def148d96136b95fdd5211 | |
| parent | b31177b028c7f2f5e84f267b40802118476a7645 (diff) | |
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>
| -rw-r--r-- | docs/qmp-commands.txt | 19 | ||||
| -rw-r--r-- | qapi/block.json | 10 |
2 files changed, 8 insertions, 21 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index 795f33f640..d586059c84 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -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 ---------- diff --git a/qapi/block.json b/qapi/block.json index bc27e20328..6f57d703f7 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', |