aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-06-23 15:06:14 +0200
committerMarkus Armbruster <armbru@redhat.com>2017-01-16 09:19:46 +0100
commitbfeafc9c532cb2f94a5ad10d3070fcd3805dadc8 (patch)
treeeb2733033e8a00dd8a319b9b37e1cee828c6e33a
parente817862b1790a7f56adb44bc80d861df6bad18ce (diff)
qmp-commands: move 'blockdev-snapshot-internal-sync' 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.txt21
-rw-r--r--qapi/block.json18
2 files changed, 16 insertions, 23 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index af903bff26..87b1fe41c5 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -169,27 +169,6 @@ Example:
<- { "return": { "status": "active", "completed": 1024000,
"total": 2048000 } }
-blockdev-snapshot-internal-sync
--------------------------------
-
-Synchronously take an internal snapshot of a block device when the format of
-image used supports it. If the name is an empty string, or a snapshot with
-name already exists, the operation will fail.
-
-Arguments:
-
-- "device": the device name or node-name of a root node to snapshot
- (json-string)
-- "name": name of the new snapshot (json-string)
-
-Example:
-
--> { "execute": "blockdev-snapshot-internal-sync",
- "arguments": { "device": "ide-hd0",
- "name": "snapshot0" }
- }
-<- { "return": {} }
-
blockdev-snapshot-delete-internal-sync
--------------------------------------
diff --git a/qapi/block.json b/qapi/block.json
index 693e234779..2e08b35769 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -81,19 +81,33 @@
##
# @blockdev-snapshot-internal-sync:
#
-# Synchronously take an internal snapshot of a block device, when the format
-# of the image used supports it.
+# Synchronously take an internal snapshot of a block device, when the
+# format of the image used supports it. If the name is an empty
+# string, or a snapshot with name already exists, the operation will
+# fail.
#
# For the arguments, see the documentation of BlockdevSnapshotInternal.
#
# Returns: nothing on success
+#
# If @device is not a valid block device, GenericError
+#
# If any snapshot matching @name exists, or @name is empty,
# GenericError
+#
# If the format of the image used does not support it,
# BlockFormatFeatureNotSupported
#
# Since: 1.7
+#
+# Example:
+#
+# -> { "execute": "blockdev-snapshot-internal-sync",
+# "arguments": { "device": "ide-hd0",
+# "name": "snapshot0" }
+# }
+# <- { "return": {} }
+#
##
{ 'command': 'blockdev-snapshot-internal-sync',
'data': 'BlockdevSnapshotInternal' }