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>
This commit is contained in:
Alberto Garcia 2015-05-07 17:58:26 +03:00 committed by Michael Tokarev
parent f20f2a1f33
commit 0caef8f6df
2 changed files with 4 additions and 3 deletions

View File

@ -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:

View File

@ -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