[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-block] [PULL 08/46] blockjob: Improve BlockJobInfo.offset/len docu
From: |
Kevin Wolf |
Subject: |
[Qemu-block] [PULL 08/46] blockjob: Improve BlockJobInfo.offset/len documentation |
Date: |
Wed, 23 May 2018 15:11:17 +0200 |
Clarify that len is just an estimation of the end value of offset, and
that offset increases monotonically while len can change arbitrarily.
While touching the documentation of offset, move it directly after len
to match the order of the declaration below.
Signed-off-by: Kevin Wolf <address@hidden>
Reviewed-by: Eric Blake <address@hidden>
Reviewed-by: John Snow <address@hidden>
---
qapi/block-core.json | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index d32ec95666..0e29abf099 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1148,7 +1148,12 @@
# @device: The job identifier. Originally the device name but other
# values are allowed since QEMU 2.7
#
-# @len: the maximum progress value
+# @len: Estimated @offset value at the completion of the job. This value can
+# arbitrarily change while the job is running, in both directions.
+#
+# @offset: Progress made until now. The unit is arbitrary and the value can
+# only meaningfully be used for the ratio of @offset to @len. The
+# value is monotonically increasing.
#
# @busy: false if the job is known to be in a quiescent state, with
# no pending I/O. Since 1.3.
@@ -1156,8 +1161,6 @@
# @paused: whether the job is paused or, if @busy is true, will
# pause itself as soon as possible. Since 1.3.
#
-# @offset: the current progress value
-#
# @speed: the rate limit, bytes per second
#
# @io-status: the status of the job (since 1.3)
--
2.13.6
- [Qemu-block] [PULL 00/46] Block layer patches, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 01/46] qemu-iotests: Fix paths for NFS, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 03/46] qemu-iotests: 086 doesn't work with NFS, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 10/46] job: Rename BlockJobType into JobType, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 08/46] blockjob: Improve BlockJobInfo.offset/len documentation,
Kevin Wolf <=
- [Qemu-block] [PULL 06/46] qemu-iotests: Remove MIG_SOCKET from non-migration tests, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 02/46] qemu-iotests: Filter NFS paths, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 04/46] sheepdog: Remove unnecessary NULL check in sd_prealloc(), Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 05/46] qemu-iotests: Add more tests to "migration" group, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 11/46] job: Add JobDriver.job_type, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 12/46] job: Add job_delete(), Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 07/46] blockjob: Update block-job-pause/resume documentation, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 17/46] job: Add Job.aio_context, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 18/46] job: Move defer_to_main_loop to Job, Kevin Wolf, 2018/05/23
- [Qemu-block] [PULL 09/46] job: Create Job, JobDriver and job_create(), Kevin Wolf, 2018/05/23