diff mbox

docs: update BLOCK_IMAGE_CORRUPTED documentation

Message ID 1431010706-13990-1-git-send-email-berto@igalia.com
State New
Headers show

Commit Message

Alberto Garcia May 7, 2015, 2:58 p.m. UTC
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>
---
 docs/qmp/qmp-events.txt | 5 +++--
 qapi/block-core.json    | 2 +-
 2 files changed, 4 insertions(+), 3 deletions(-)

Comments

Eric Blake May 7, 2015, 5:10 p.m. UTC | #1
On 05/07/2015 08:58 AM, Alberto Garcia wrote:
> 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>
> ---
>  docs/qmp/qmp-events.txt | 5 +++--
>  qapi/block-core.json    | 2 +-
>  2 files changed, 4 insertions(+), 3 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>
Michael Tokarev May 8, 2015, 6:49 a.m. UTC | #2
Applied to -trivial, thank you!

/mjt
diff mbox

Patch

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index b19e490..64ba46c 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 dcf7c04..863ffea 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