From df961637027df4093aaad5faab16a617ab13b335 Mon Sep 17 00:00:00 2001 From: Ben Noordhuis Date: Wed, 16 Mar 2016 10:15:27 +0100 Subject: [PATCH] doc: clarify uv_loop_close() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Make explicit that handles and requests should be closed before calling uv_loop_close(). Fixes: https://github.com/libuv/libuv/issues/765 Reviewed-By: Colin Ihrig Reviewed-By: Saúl Ibarra Corretgé --- docs/src/loop.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/src/loop.rst b/docs/src/loop.rst index 2a01d796..1f504cb3 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -71,9 +71,10 @@ API .. c:function:: int uv_loop_close(uv_loop_t* loop) - Closes all internal loop resources. This function must only be called once - the loop has finished its execution or it will return UV_EBUSY. After this - function returns the user shall free the memory allocated for the loop. + Releases all internal loop resources. Call this function only when the loop + has finished executing and all open handles and requests have been closed, + or it will return UV_EBUSY. After this function returns, the user can free + the memory allocated for the loop. .. c:function:: uv_loop_t* uv_default_loop(void)