Skip to content

Commit 6d71cbc

Browse files
eljefedelrodeodeljefeFishrock123
authored andcommitted
doc: add note for fs.watch virtualized env
Fixes: #6765 PR-URL: #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>
1 parent a3b3a47 commit 6d71cbc

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/fs.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,9 +1461,10 @@ to be notified of filesystem changes.
14611461
* On Windows systems, this feature depends on `ReadDirectoryChangesW`.
14621462

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

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

0 commit comments

Comments
 (0)