doc: add note for fs.watch virtualized env

Fixes: #6765 PR-URL: #6809 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
nodejs · May 23, 2016 · 6d71cbc · 6d71cbc
1 parent a3b3a47
commit 6d71cbc
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -1461,9 +1461,10 @@ to be notified of filesystem changes.
 * On Windows systems, this feature depends on `ReadDirectoryChangesW`.
 
 If the underlying functionality is not available for some reason, then
-`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
-reliably or at all.
+`fs.watch` will not be able to function. For example, watching files or
+directories can be unreliable, and in some cases impossible, on network file
+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
 less reliable.