aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorSaúl Ibarra Corretgé <saghul@gmail.com>2015-01-14 09:39:46 +0100
committerSaúl Ibarra Corretgé <saghul@gmail.com>2015-01-17 09:16:32 +0100
commit7a19a48df89c4a7606162828d8d69efd1de57933 (patch)
tree89b33fcc5c9609178802bf0ccad00cd248a41801 /docs/src
parentb30a3e677b144afa19143490e9ffc9f882cb4722 (diff)
downloadlibuv-7a19a48df89c4a7606162828d8d69efd1de57933.tar.gz
libuv-7a19a48df89c4a7606162828d8d69efd1de57933.zip
doc: clarify which flags are supported in uv_fs_event_start
PR-URL: https://github.com/libuv/libuv/pull/135 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/fs_event.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/src/fs_event.rst b/docs/src/fs_event.rst
index 9bc9939f..0c9041e0 100644
--- a/docs/src/fs_event.rst
+++ b/docs/src/fs_event.rst
@@ -87,6 +87,9 @@ API
Start the handle with the given callback, which will watch the specified
`path` for changes. `flags` can be an ORed mask of :c:type:`uv_fs_event_flags`.
+ .. note:: Currently the only supported flag is ``UV_FS_EVENT_RECURSIVE`` and
+ only on OSX.
+
.. c:function:: int uv_fs_event_stop(uv_fs_event_t* handle)
Stop the handle, the callback will no longer be called.