From 737cd1fb4f79295bba665f2d965718b006f87ac1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Tue, 20 Jan 2015 09:00:12 +0100 Subject: [PATCH] doc: clarify uv_default_loop Indicate that it can (and should) also be closed, currently it's not "special" in any way. PR-URL: https://github.com/libuv/libuv/pull/147 Reviewed-By: Ben Noordhuis --- docs/src/loop.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/src/loop.rst b/docs/src/loop.rst index d347534b..203672bd 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -80,6 +80,12 @@ API Returns the initialized default loop. It may return NULL in case of allocation failure. + This function is just a convenient way for having a global loop throughout + an application, the default loop is in no way different than the ones + initialized with :c:func:`uv_loop_init`. As such, the default loop can (and + should) be closed with :c:func:`uv_loop_close` so the resources associated + with it are freed. + .. c:function:: int uv_run(uv_loop_t* loop, uv_run_mode mode) This function runs the event loop. It will act differently depending on the