aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlberto Garcia <berto@igalia.com>2015-05-07 17:58:26 +0300
committerMichael Tokarev <mjt@tls.msk.ru>2015-05-08 14:11:10 +0300
commit0caef8f6df4a9426bd6333ab843ce51ce005d7d0 (patch)
tree75713cdde579e47b5a6511027e4ca28b67dfdd20
parentf20f2a1f339b99f5b840367236ddce9d9736247c (diff)
docs: update BLOCK_IMAGE_CORRUPTED documentation
Label the "size" and "offset" fields in BLOCK_IMAGE_CORRUPTED as optional, and clarify that the latter refers to the host's offset into the image. Signed-off-by: Alberto Garcia <berto@igalia.com> Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Michael Tokarev <mjt@tls.msk.ru>
-rw-r--r--docs/qmp/qmp-events.txt5
-rw-r--r--qapi/block-core.json2
2 files changed, 4 insertions, 3 deletions
diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index b19e490eb5..64ba46c769 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -43,9 +43,10 @@ Data:
- "msg": Informative message (e.g., reason for the corruption)
(json-string)
- "offset": If the corruption resulted from an image access, this
- is the access offset into the image (json-int)
+ is the host's access offset into the image
+ (json-int, optional)
- "size": If the corruption resulted from an image access, this
- is the access size (json-int)
+ is the access size (json-int, optional)
Example:
diff --git a/qapi/block-core.json b/qapi/block-core.json
index dcf7c04ffa..863ffea0c7 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1847,7 +1847,7 @@
# not guaranteed to be stable
#
# @offset: #optional, if the corruption resulted from an image access, this is
-# the access offset into the image
+# the host's access offset into the image
#
# @size: #optional, if the corruption resulted from an image access, this is
# the access size