From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([208.118.235.92]:33646) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1THcPk-0005HL-PB for qemu-devel@nongnu.org; Fri, 28 Sep 2012 11:23:46 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1THcPe-00019H-U8 for qemu-devel@nongnu.org; Fri, 28 Sep 2012 11:23:40 -0400 Received: from mail-pb0-f45.google.com ([209.85.160.45]:40969) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1THcPe-00017A-Nm for qemu-devel@nongnu.org; Fri, 28 Sep 2012 11:23:34 -0400 Received: by mail-pb0-f45.google.com with SMTP id rp2so5308240pbb.4 for ; Fri, 28 Sep 2012 08:23:34 -0700 (PDT) Sender: Paolo Bonzini From: Paolo Bonzini Date: Fri, 28 Sep 2012 17:22:46 +0200 Message-Id: <1348845782-15073-4-git-send-email-pbonzini@redhat.com> In-Reply-To: <1348845782-15073-1-git-send-email-pbonzini@redhat.com> References: <1348845782-15073-1-git-send-email-pbonzini@redhat.com> Subject: [Qemu-devel] [PATCH 03/19] block: fix documentation of block_job_cancel_sync List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: kwolf@redhat.com Do this in a separate commit before we move the functions to blockjob.h. Signed-off-by: Paolo Bonzini --- 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