diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2012-09-28 17:22:46 +0200 |
|---|---|---|
| committer | Kevin Wolf <kwolf@redhat.com> | 2012-09-28 19:08:27 +0200 |
| commit | 7e03a9342fff50f2a6a4086906fa66e6c6d4351d (patch) | |
| tree | c75fc3aa225124a3260abc3c55e5cd7a1c169514 /block_int.h | |
| parent | 7ef1507045d35bd4d220cf3bfe0e80e7ac101d00 (diff) | |
block: fix documentation of block_job_cancel_sync
Do this in a separate commit before we move the functions to
blockjob.h.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
Diffstat (limited to 'block_int.h')
| -rw-r--r-- | block_int.h | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/block_int.h b/block_int.h index 56164a742a..6b6b3ab639 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. |