Skip to content

Commit 2b0f40c

Browse files
eljefedelrodeodeljefeMyles Borins
authored and
Myles Borins
committed
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]>
1 parent 1549899 commit 2b0f40c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/fs.markdown

+4-3
Original file line numberDiff line numberDiff line change
@@ -823,9 +823,10 @@ to be notified of filesystem changes.
823823
* On Windows systems, this feature depends on `ReadDirectoryChangesW`.
824824

825825
If the underlying functionality is not available for some reason, then
826-
`fs.watch` will not be able to function. For example, watching files or
827-
directories on network file systems (NFS, SMB, etc.) often doesn't work
828-
reliably or at all.
826+
`fs.watch` will not be able to function. For example, watching files or
827+
directories can be unreliable, and in some cases impossible, on network file
828+
systems (NFS, SMB, etc), or host file systems when using virtualization software
829+
such as Vagrant, Docker, etc.
829830

830831
You can still use `fs.watchFile`, which uses stat polling, but it is slower and
831832
less reliable.

0 commit comments

Comments
 (0)