1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add note for fs.watch virtualized env

Browse Source 
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>
This commit is contained in:
Robert Jefe Lindstaedt 2016-05-17 15:10:25 +02:00
parent 2ab75b7a42
commit ae0f68d6e1
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/api/fs.md
View File

@ -1469,9 +1469,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.