[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-trivial] [Qemu-devel] [PATCH v2] coroutine: Fix documentation
From: |
Fam Zheng |
Subject: |
Re: [Qemu-trivial] [Qemu-devel] [PATCH v2] coroutine: Fix documentation of co_aio_sleep_ns() |
Date: |
Thu, 9 Nov 2017 14:12:00 +0800 |
User-agent: |
Mutt/1.9.1 (2017-09-22) |
On Wed, 11/08 10:55, Eric Blake wrote:
> co_sleep_ns() was removed in commit 0b9caf9b, leaving behind a
> stale comment. Update the documentation to match the current
> usage of this function.
>
> Suggested-by: Paolo Bonzini <address@hidden>
> Signed-off-by: Eric Blake <address@hidden>
>
> ---
> v2: instead of just blindly cribbing from Paolo's email, try to incorporate
> the feedback given on the wording
> ---
> include/qemu/coroutine.h | 7 +++++--
> 1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/include/qemu/coroutine.h b/include/qemu/coroutine.h
> index 9aff9a735e..10ab50a98c 100644
> --- a/include/qemu/coroutine.h
> +++ b/include/qemu/coroutine.h
> @@ -262,8 +262,11 @@ void qemu_co_rwlock_unlock(CoRwlock *lock);
> /**
> * Yield the coroutine for a given duration
> *
> - * Behaves similarly to co_sleep_ns(), but the sleeping coroutine will be
> - * resumed when using aio_poll().
> + * This function uses timers and hence needs to know the event loop
> + * (#AioContext) to place the timer on. After the time elapses, the
> + * current coroutine will restart with the same #AioContext it is
> + * currently running in, even if that is different than the timer
> + * context passed to co_aio_sleep_ns().
> */
> void coroutine_fn co_aio_sleep_ns(AioContext *ctx, QEMUClockType type,
> int64_t ns);
> --
> 2.13.6
>
>
Reviewed-by: Fam Zheng <address@hidden>