yeahuh / rpms / qemu-kvm

Forked from rpms/qemu-kvm 2 years ago
Clone

Blame SOURCES/kvm-blockjob-Improve-BlockJobInfo.offset-len-documentati.patch

ae23c9
From 82c4f0c7c192af2c7db4b7d4ca6ab3454e4b25f5 Mon Sep 17 00:00:00 2001
ae23c9
From: Kevin Wolf <kwolf@redhat.com>
ae23c9
Date: Tue, 26 Jun 2018 09:47:58 +0200
ae23c9
Subject: [PATCH 090/268] blockjob: Improve BlockJobInfo.offset/len
ae23c9
 documentation
ae23c9
ae23c9
RH-Author: Kevin Wolf <kwolf@redhat.com>
ae23c9
Message-id: <20180626094856.6924-16-kwolf@redhat.com>
ae23c9
Patchwork-id: 81087
ae23c9
O-Subject: [RHV-7.6 qemu-kvm-rhev PATCH v2 15/73] blockjob: Improve BlockJobInfo.offset/len documentation
ae23c9
Bugzilla: 1513543
ae23c9
RH-Acked-by: Jeffrey Cody <jcody@redhat.com>
ae23c9
RH-Acked-by: Max Reitz <mreitz@redhat.com>
ae23c9
RH-Acked-by: Fam Zheng <famz@redhat.com>
ae23c9
ae23c9
Clarify that len is just an estimation of the end value of offset, and
ae23c9
that offset increases monotonically while len can change arbitrarily.
ae23c9
ae23c9
While touching the documentation of offset, move it directly after len
ae23c9
to match the order of the declaration below.
ae23c9
ae23c9
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
ae23c9
Reviewed-by: Eric Blake <eblake@redhat.com>
ae23c9
Reviewed-by: John Snow <jsnow@redhat.com>
ae23c9
(cherry picked from commit a81e0a825e3b89039a427bca037112f461b95fec)
ae23c9
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
ae23c9
Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
ae23c9
---
ae23c9
 qapi/block-core.json | 9 ++++++---
ae23c9
 1 file changed, 6 insertions(+), 3 deletions(-)
ae23c9
ae23c9
diff --git a/qapi/block-core.json b/qapi/block-core.json
ae23c9
index 31bf64a..2b4566f 100644
ae23c9
--- a/qapi/block-core.json
ae23c9
+++ b/qapi/block-core.json
ae23c9
@@ -1148,7 +1148,12 @@
ae23c9
 # @device: The job identifier. Originally the device name but other
ae23c9
 #          values are allowed since QEMU 2.7
ae23c9
 #
ae23c9
-# @len: the maximum progress value
ae23c9
+# @len: Estimated @offset value at the completion of the job. This value can
ae23c9
+#       arbitrarily change while the job is running, in both directions.
ae23c9
+#
ae23c9
+# @offset: Progress made until now. The unit is arbitrary and the value can
ae23c9
+#          only meaningfully be used for the ratio of @offset to @len. The
ae23c9
+#          value is monotonically increasing.
ae23c9
 #
ae23c9
 # @busy: false if the job is known to be in a quiescent state, with
ae23c9
 #        no pending I/O.  Since 1.3.
ae23c9
@@ -1156,8 +1161,6 @@
ae23c9
 # @paused: whether the job is paused or, if @busy is true, will
ae23c9
 #          pause itself as soon as possible.  Since 1.3.
ae23c9
 #
ae23c9
-# @offset: the current progress value
ae23c9
-#
ae23c9
 # @speed: the rate limit, bytes per second
ae23c9
 #
ae23c9
 # @io-status: the status of the job (since 1.3)
ae23c9
-- 
ae23c9
1.8.3.1
ae23c9