aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
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.