Browse Source

doc: add note for fs.watch virtualized env

Fixes: https://github.com/nodejs/node/issues/6765
PR-URL: https://github.com/nodejs/node/pull/6809
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
v4.x
Robert Jefe Lindstaedt 9 years ago
committed by Myles Borins
parent
commit
2b0f40ca16
  1. 7
      doc/api/fs.markdown

7
doc/api/fs.markdown

@ -823,9 +823,10 @@ to be notified of filesystem changes.
* On Windows systems, this feature depends on `ReadDirectoryChangesW`. * On Windows systems, this feature depends on `ReadDirectoryChangesW`.
If the underlying functionality is not available for some reason, then If the underlying functionality is not available for some reason, then
`fs.watch` will not be able to function. For example, watching files or `fs.watch` will not be able to function. For example, watching files or
directories on network file systems (NFS, SMB, etc.) often doesn't work directories can be unreliable, and in some cases impossible, on network file
reliably or at all. systems (NFS, SMB, etc), or host file systems when using virtualization software
such as Vagrant, Docker, etc.
You can still use `fs.watchFile`, which uses stat polling, but it is slower and You can still use `fs.watchFile`, which uses stat polling, but it is slower and
less reliable. less reliable.

Loading…
Cancel
Save