[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 03/19] block: fix documentation of block_job_cancel_
From: |
Paolo Bonzini |
Subject: |
[Qemu-devel] [PATCH 03/19] block: fix documentation of block_job_cancel_sync |
Date: |
Fri, 28 Sep 2012 17:22:46 +0200 |
Do this in a separate commit before we move the functions to
blockjob.h.
Signed-off-by: Paolo Bonzini <address@hidden>
---
block_int.h | 12 +++++-------
1 file modificato, 5 inserzioni(+), 7 rimozioni(-)
diff --git a/block_int.h b/block_int.h
index ac4245c..b025fa0 100644
--- a/block_int.h
+++ b/block_int.h
@@ -425,15 +425,13 @@ void block_job_cancel(BlockJob *job);
bool block_job_is_cancelled(BlockJob *job);
/**
- * block_job_cancel:
+ * block_job_cancel_sync:
* @job: The job to be canceled.
*
- * Asynchronously cancel the job and wait for it to reach a quiescent
- * state. Note that the completion callback will still be called
- * asynchronously, hence it is *not* valid to call #bdrv_delete
- * immediately after #block_job_cancel_sync. Users of block jobs
- * will usually protect the BlockDriverState objects with a reference
- * count, should this be a concern.
+ * Synchronously cancel the job. The completion callback is called
+ * before the function returns. The job may actually complete
+ * instead of canceling itself; the circumstances under which this
+ * happens depend on the kind of job that is active.
*
* Returns the return value from the job if the job actually completed
* during the call, or -ECANCELED if it was canceled.
--
1.7.12
- [Qemu-devel] [PULL for Kevin 00/19] Block job improvements part 1, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 01/19] qerror/block: introduce QERR_BLOCK_JOB_NOT_ACTIVE, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 02/19] blockdev: rename block_stream_cb to a generic block_job_cb, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 03/19] block: fix documentation of block_job_cancel_sync,
Paolo Bonzini <=
- [Qemu-devel] [PATCH 04/19] block: move job APIs to separate files, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 06/19] qmp: add 'busy' member to BlockJobInfo, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 05/19] block: add block_job_query, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 09/19] qemu-iotests: add test for pausing a streaming operation, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 08/19] qmp: add block-job-pause and block-job-resume, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 07/19] block: add support for job pause/resume, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 10/19] block: rename block_job_complete to block_job_completed, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 11/19] iostatus: rename BlockErrorAction, BlockQMPEventAction, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 15/19] block: introduce block job error, Paolo Bonzini, 2012/09/28
- [Qemu-devel] [PATCH 19/19] qemu-iotests: add tests for streaming error handling, Paolo Bonzini, 2012/09/28