From 723830f17efc1debb8c58245b2d938bc0887f6a9 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Mon, 30 May 2016 17:12:17 -0400 Subject: [PATCH 1/2] doc: add links to platform specific mechanisms As requested in earlier PR adding detail for Aix, add link for each of the platform specific technologies used for file system watching. --- doc/api/fs.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index dc6923c1f20da8..d56fb4be6411d9 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1462,12 +1462,20 @@ The recursive option is only supported on OS X and Windows. This feature depends on the underlying operating system providing a way to be notified of filesystem changes. -* On Linux systems, this uses `inotify`. -* On BSD systems, this uses `kqueue`. -* On OS X, this uses `kqueue` for files and 'FSEvents' for directories. +* On Linux systems, this uses + [`inotify`](http://man7.org/linux/man-pages/man7/inotify.7.html). +* On BSD systems, this uses + [`kqueue`](https://www.freebsd.org/cgi/man.cgi?kqueue). +* On OS X, this uses [`kqueue`](https://www.freebsd.org/cgi/man.cgi?kqueue) + for files and + [`FSEvents`](https://developer.apple.com/library/mac/documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005289-CH1-SW1) + for directories. * On SunOS systems (including Solaris and SmartOS), this uses `event ports`. -* On Windows systems, this feature depends on `ReadDirectoryChangesW`. -* On Aix systems, this feature depends on `AHAFS`, which must be enabled. +* On Windows systems, this feature depends on + [`ReadDirectoryChangesW`](https://msdn.microsoft.com/en-us/library/windows/desktop/aa365465%28v=vs.85%29.aspx). +* On Aix systems, this feature depends on + [`AHAFS`](https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/), + which must be enabled. If the underlying functionality is not available for some reason, then `fs.watch` will not be able to function. For example, watching files or From 338d924a78a4b4579b62dce409668d0f5c8530d0 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Tue, 31 May 2016 16:33:30 -0400 Subject: [PATCH 2/2] Address initial comments --- doc/api/fs.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index d56fb4be6411d9..9d6f074ef96063 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1462,20 +1462,12 @@ The recursive option is only supported on OS X and Windows. This feature depends on the underlying operating system providing a way to be notified of filesystem changes. -* On Linux systems, this uses - [`inotify`](http://man7.org/linux/man-pages/man7/inotify.7.html). -* On BSD systems, this uses - [`kqueue`](https://www.freebsd.org/cgi/man.cgi?kqueue). -* On OS X, this uses [`kqueue`](https://www.freebsd.org/cgi/man.cgi?kqueue) - for files and - [`FSEvents`](https://developer.apple.com/library/mac/documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005289-CH1-SW1) - for directories. -* On SunOS systems (including Solaris and SmartOS), this uses `event ports`. -* On Windows systems, this feature depends on - [`ReadDirectoryChangesW`](https://msdn.microsoft.com/en-us/library/windows/desktop/aa365465%28v=vs.85%29.aspx). -* On Aix systems, this feature depends on - [`AHAFS`](https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/), - which must be enabled. +* On Linux systems, this uses [`inotify`] +* On BSD systems, this uses [`kqueue`] +* On OS X, this uses [`kqueue`] for files and [`FSEvents`] for directories. +* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`]. +* On Windows systems, this feature depends on [`ReadDirectoryChangesW`]. +* On Aix systems, this feature depends on [`AHAFS`], which must be enabled. If the underlying functionality is not available for some reason, then `fs.watch` will not be able to function. For example, watching files or @@ -1961,3 +1953,9 @@ The following constants are meant for use with the [`fs.Stats`][] object's [Writable Stream]: stream.html#stream_class_stream_writable [inode]: http://www.linux.org/threads/intro-to-inodes.4130 [FS Constants]: #fs_fs_constants +[`inotify`]: http://man7.org/linux/man-pages/man7/inotify.7.html +[`kqueue`]: https://www.freebsd.org/cgi/man.cgi?kqueue +[`FSEvents`]: https://developer.apple.com/library/mac/documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005289-CH1-SW1 +[`event ports`]: http://illumos.org/man/port_create +[`ReadDirectoryChangesW`]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365465%28v=vs.85%29.aspx +[`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/