doc: document uv_loop_configure()

Move the comments from commit 9da5fd4 from the v0.10 branch into docs/.

1 files changed, 17 insertions, 0 deletions

diff --git a/docs/src/loop.rst b/docs/src/loop.rst
index 5d871433..0a9e8a60 100644
--- a/docs/src/loop.rst
+++ b/docs/src/loop.rst
@@ -50,6 +50,23 @@ API
 
     Initializes the given `uv_loop_t` structure.
 
+.. c:function:: int uv_loop_configure(uv_loop_t* loop, uv_loop_option option, ...)
+
+    Set additional loop options.  You should normally call this before the
+    first call to :c:func:`uv_run` unless mentioned otherwise.
+
+    Returns 0 on success or a UV_E* error code on failure.  Be prepared to
+    handle UV_ENOSYS; it means the loop option is not supported by the platform.
+
+    Supported options:
+
+    - UV_LOOP_BLOCK_SIGNAL: Block a signal when polling for new events.  The
+      second argument to :c:func:`uv_loop_configure` is the signal number.
+
+      This operation is currently only implemented for SIGPROF signals,
+      to suppress unnecessary wakeups when using a sampling profiler.
+      Requesting other signals will fail with UV_EINVAL.
+
 .. c:function:: int uv_loop_close(uv_loop_t* loop)
 
     Closes all internal loop resources. This function must only be called once