From 6c2fd34e396de7fde8dfbb5ebbcc63306077fbea Mon Sep 17 00:00:00 2001 From: cjihrig Date: Mon, 22 May 2017 12:25:11 -0400 Subject: [PATCH] doc: mark uv_loop_fork() as experimental uv_loop_fork() was recently added, but is known to contain bugs. This commit marks the function as experimental so that bugs can be addressed without blocking further libuv releases. Refs: https://github.com/libuv/libuv/pull/846 Refs: https://github.com/libuv/libuv/pull/1269 Refs: https://github.com/libuv/libuv/issues/1264 PR-URL: https://github.com/libuv/libuv/pull/1356 Reviewed-By: Santiago Gimeno Reviewed-By: Ben Noordhuis --- docs/src/loop.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/src/loop.rst b/docs/src/loop.rst index 74f96341..02543171 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -191,6 +191,11 @@ API This function is not implemented on Windows, where it returns ``UV_ENOSYS``. + .. caution:: + + This function is experimental. It may contain bugs, and is subject to + change or removal. API and ABI stability is not guaranteed. + .. note:: On Mac OS X, if directory FS event handles were in use in the