diff options
| author | cjihrig <cjihrig@gmail.com> | 2017-05-22 12:25:11 -0400 |
|---|---|---|
| committer | cjihrig <cjihrig@gmail.com> | 2017-05-25 11:41:27 -0400 |
| commit | 6c2fd34e396de7fde8dfbb5ebbcc63306077fbea (patch) | |
| tree | c8f18d08ca7301797080200ca68d8f32d8facff2 /docs/src | |
| parent | 621655352c4f591946207e7cf58664a6c4ad03e4 (diff) | |
| download | libuv-6c2fd34e396de7fde8dfbb5ebbcc63306077fbea.tar.gz libuv-6c2fd34e396de7fde8dfbb5ebbcc63306077fbea.zip | |
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 <santiago.gimeno@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/loop.rst | 5 |
1 files changed, 5 insertions, 0 deletions
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 |