xemu-project/xemu
1
0
Fork 0
mirror of https://github.com/xemu-project/xemu.git synced 2024-11-23 19:49:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

block: fix documentation of block_job_cancel_sync

Browse Source 
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>
This commit is contained in:
Paolo Bonzini 2012-09-28 17:22:46 +02:00 committed by Kevin Wolf
parent 7ef1507045
commit 7e03a9342f
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
block_int.h
View File

@ -425,15 +425,13 @@ void block_job_cancel(BlockJob *job);
bool block_job_is_cancelled(BlockJob *job); bool block_job_is_cancelled(BlockJob *job);
/** /**
* block_job_cancel: * block_job_cancel_sync:
* @job: The job to be canceled. * @job: The job to be canceled.
* *
* Asynchronously cancel the job and wait for it to reach a quiescent * Synchronously cancel the job. The completion callback is called
* state. Note that the completion callback will still be called * before the function returns. The job may actually complete
* asynchronously, hence it is *not* valid to call #bdrv_delete * instead of canceling itself; the circumstances under which this
* immediately after #block_job_cancel_sync. Users of block jobs * happens depend on the kind of job that is active.
* will usually protect the BlockDriverState objects with a reference
* count, should this be a concern.
* *
* Returns the return value from the job if the job actually completed * Returns the return value from the job if the job actually completed
* during the call, or -ECANCELED if it was canceled. * during the call, or -ECANCELED if it was canceled.