From: Nathan Youngman <git@nathany.com>
Date: Sun, 27 Oct 2013 22:13:31 +0000 (-0600)
Subject: Add note about Spotlight double modify events to README
X-Git-Tag: v1.7.2~334^2~2
X-Git-Url: https://go.fuhry.dev/?a=commitdiff_plain;h=da06868d3db1c807f2dcc2a8bafdc9daf22be0f3;p=fsnotify.git

Add note about Spotlight double modify events to README

#62
---

diff --git a/README.md b/README.md
index bf686aa..aedf80b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
 
 [![Build Status](https://goci.herokuapp.com/project/image/github.com/howeyc/fsnotify)](http://goci.me/project/github.com/howeyc/fsnotify)
 
-[GoDoc](http://go.pkgdoc.org/github.com/howeyc/fsnotify)
+[GoDoc](http://godoc.org/github.com/howeyc/fsnotify)
 
 Cross platform, works on:
 * Windows
@@ -59,15 +59,22 @@ For each event:
 * IsModify()
 * IsRename()
 
-Notes:
-* When a file is renamed to another directory is it still being watched?
-    * No (it shouldn't be, unless you are watching where it was moved to).
-* When I watch a directory, are all subdirectories watched as well?
-    * No, you must add watches for any directory you want to watch.
-* Do I have to watch the Error and Event channels in a separate goroutine?
-    * As of now, yes. Looking into making this single-thread friendly.
-* There are OS-specific limits as to how many watches can be created:
-    * Linux: /proc/sys/fs/inotify/max_user_watches contains the limit,
-    reaching this limit results in a "no space left on device" error.
-    * BSD / OSX: sysctl variables "kern.maxfiles" and "kern.maxfilesperproc",
-    reaching these limits results in a "too many open files" error.
+### FAQ
+
+**When a file is moved to another directory is it still being watched?**
+No (it shouldn't be, unless you are watching where it was moved to).
+
+**When I watch a directory, are all subdirectories watched as well?**
+No, you must add watches for any directory you want to watch (a recursive watcher is in the works #56).
+
+**Do I have to watch the Error and Event channels in a separate goroutine?**
+As of now, yes. Looking into making this single-thread friendly (see #7)
+
+**Why am I receiving multiple events for the same file on OS X?**
+Spotlight indexing on OS X can result in multiple events (see #62). A temporary workaround is to add your folder(s) to the *Spotlight Privacy settings* until we have a native FSEvents implementation (see #54).
+
+**How many files can be watched at once?**
+There are OS-specific limits as to how many watches can be created:
+* Linux: /proc/sys/fs/inotify/max_user_watches contains the limit,
+reaching this limit results in a "no space left on device" error.
+* BSD / OSX: sysctl variables "kern.maxfiles" and "kern.maxfilesperproc", reaching these limits results in a "too many open files" error.