aboutsummaryrefslogtreecommitdiff
path: root/qapi-schema.json
diff options
context:
space:
mode:
authorJeff Cody <jcody@redhat.com>2014-01-24 09:02:37 -0500
committerKevin Wolf <kwolf@redhat.com>2014-01-24 16:12:49 +0100
commit37222900743962e146a82b7077a18c3f39859a19 (patch)
treebb0f5579a3ed79acf046886598c941788f29c6bd /qapi-schema.json
parent4da83585961631bfc10831dd26c4afda2a8b23e8 (diff)
block: update block commit documentation regarding image truncation
This updates the documentation for commiting snapshot images. Specifically, this highlights what happens when the base image is either smaller or larger than the snapshot image being committed. In the case of the base image being smaller, it is resized to the larger size of the snapshot image. In the case of the base image being larger, it is not resized automatically, but once the commit has completed it is safe for the user to truncate the base image. Signed-off-by: Jeff Cody <jcody@redhat.com> Reviewed-by: Fam Zheng <famz@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Diffstat (limited to 'qapi-schema.json')
-rw-r--r--qapi-schema.json7
1 files changed, 7 insertions, 0 deletions
diff --git a/qapi-schema.json b/qapi-schema.json
index e04949de52..1ff607ac3c 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1994,6 +1994,13 @@
# user needs to complete the job with the block-job-complete
# command after getting the ready event. (Since 2.0)
#
+# If the base image is smaller than top, then the base image
+# will be resized to be the same size as top. If top is
+# smaller than the base image, the base will not be
+# truncated. If you want the base image size to match the
+# size of the smaller top, you can safely truncate it
+# yourself once the commit operation successfully completes.
+#
#
# @speed: #optional the maximum speed, in bytes per second
#