Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 51d295e

Browse filesBrowse files
mhdawsonevanlucas
authored andcommitted
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. PR-URL: #7071 Reviewed-By: Robert Jefe Lindstädt <robert.lindstaedt@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com>
1 parent 37550e6 commit 51d295e
Copy full SHA for 51d295e

File tree

Expand file treeCollapse file tree

1 file changed

+13
-6
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+13
-6
lines changed
Open diff view settings
Collapse file

‎doc/api/fs.md‎

Copy file name to clipboardExpand all lines: doc/api/fs.md
+13-6Lines changed: 13 additions & 6 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1454,12 +1454,12 @@ The recursive option is only supported on OS X and Windows.
14541454
This feature depends on the underlying operating system providing a way
14551455
to be notified of filesystem changes.
14561456

1457-
* On Linux systems, this uses `inotify`.
1458-
* On BSD systems, this uses `kqueue`.
1459-
* On OS X, this uses `kqueue` for files and 'FSEvents' for directories.
1460-
* On SunOS systems (including Solaris and SmartOS), this uses `event ports`.
1461-
* On Windows systems, this feature depends on `ReadDirectoryChangesW`.
1462-
* On Aix systems, this feature depends on `AHAFS`, which must be enabled.
1457+
* On Linux systems, this uses [`inotify`]
1458+
* On BSD systems, this uses [`kqueue`]
1459+
* On OS X, this uses [`kqueue`] for files and [`FSEvents`] for directories.
1460+
* On SunOS systems (including Solaris and SmartOS), this uses [`event ports`].
1461+
* On Windows systems, this feature depends on [`ReadDirectoryChangesW`].
1462+
* On Aix systems, this feature depends on [`AHAFS`], which must be enabled.
14631463

14641464
If the underlying functionality is not available for some reason, then
14651465
`fs.watch` will not be able to function. For example, watching files or
@@ -1724,3 +1724,10 @@ Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.
17241724
[Readable Stream]: stream.html#stream_class_stream_readable
17251725
[Writable Stream]: stream.html#stream_class_stream_writable
17261726
[inode]: http://www.linux.org/threads/intro-to-inodes.4130
1727+
[FS Constants]: #fs_fs_constants
1728+
[`inotify`]: http://man7.org/linux/man-pages/man7/inotify.7.html
1729+
[`kqueue`]: https://www.freebsd.org/cgi/man.cgi?kqueue
1730+
[`FSEvents`]: https://developer.apple.com/library/mac/documentation/Darwin/Conceptual/FSEvents_ProgGuide/Introduction/Introduction.html#//apple_ref/doc/uid/TP40005289-CH1-SW1
1731+
[`event ports`]: http://illumos.org/man/port_create
1732+
[`ReadDirectoryChangesW`]: https://msdn.microsoft.com/en-us/library/windows/desktop/aa365465%28v=vs.85%29.aspx
1733+
[`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.