From 062009c0366c622ac66b74818c9207eb81a86978 Mon Sep 17 00:00:00 2001 From: Robert Jefe Lindstaedt Date: Tue, 17 May 2016 15:10:25 +0200 Subject: [PATCH] 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 Reviewed-By: James M Snell Reviewed-By: Colin Ihrig Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Michael Dawson --- doc/api/fs.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown index fa01a51e3df9ad..ed87141c07cc2d 100644 --- a/doc/api/fs.markdown +++ b/doc/api/fs.markdown @@ -823,9 +823,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.