yeahuh / rpms / qemu-kvm

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