Skip to content

Commit

Permalink
More obvious docs for watching network mounts
Browse files Browse the repository at this point in the history
  • Loading branch information
es128 committed Feb 6, 2015
1 parent 70dcd0c commit 63059b9
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,10 @@ derived. Paths emitted with events will be relative to this.
polling for binary files (see extensions in src/is-binary).
* `usePolling` (default: `false`).
Whether to use fs.watchFile (backed by polling), or fs.watch. If polling
leads to high CPU utilization, consider setting this to `false`. Polling
may be necessary to successfully watch files in certain situations, such as
network mounted drives. Setting to `true` explicitly on OS X overrides the
leads to high CPU utilization, consider setting this to `false`. It is
typically necessary to **set this to `true` to successfully watch files over
a network**, and it may be necessary to successfully watch files in other
non-standard situations. Setting to `true` explicitly on OS X overrides the
`useFsEvents` default.
* `useFsEvents` (default: `true` on OS X). Whether to use the
`fsevents` watching interface if available. When set to `true` explicitly
Expand Down

0 comments on commit 63059b9

Please sign in to comment.