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