Skip to content

Commit

Permalink
Add notes for fsnotify#46 and fsnotify#48 limitations of macOS
Browse files Browse the repository at this point in the history
  • Loading branch information
pbnjay committed Jan 19, 2022
1 parent 6f0aa3b commit e0a76ce
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@

**Warning:** This API should be considered unstable.

## Caveats

Known caveats of the macOS FSEvents API which this package uses under the hood:

- FSEvents returns events for the named path only, so unless you want to follow updates to a symlink itself (unlikely), you should use `filepath.EvalSymlinks` to get the target path to watch.
- There is an internal macOS limitation of 4096 watched paths. Watching more paths will result in an error calling `Start()`. Note that FSEvents is intended to be a recursive watcher by design, it is actually more efficient to watch the containing path than each file in a large directory.

## Contributing

Request features and report bugs using the [GitHub Issue Tracker](https://github.com/fsnotify/fsevents/issues).
Expand Down

0 comments on commit e0a76ce

Please sign in to comment.