minit

commit d80e2180795c3ce4ec5c687e08388b601678acb8
parent a4463068a782781414697387eba321d67db1b523
Author: leitner <leitner>
Date:   Mon, 27 Oct 2014 14:06:17 +0000

document race condition

Diffstat:
M
ftrigger.1
 | 
15
++++++++++++++-

1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/ftrigger.1 b/ftrigger.1
@@ -28,7 +28,20 @@ And it is possible to watch multiple files with different triggers:
 
 % ftrigger '@echo a updated' /tmp/a '@echo b updated' /tmp/b
 
+.SH "RACE CONDITION"
+
+The inotify API has an inherent race condition.  ftrigger has to watch
+both the file and the directory it is in for changes.  If the file is
+newly created, ftrigger will receive a notification via the directory,
+and will then add a watch to the newly created file, to get notified if
+somebody closes the file who had it open for writing.
+
+If the other process closes the file before ftrigger has a chance to add
+the watch on the file, ftrigger will never get notified.  In practice, I
+have only seen this happen with touch, where the open(3) is immediately
+followed by the close(3), and there is no write(3) in the middle.
+
 .SH AUTHOR
-minit was written by Felix von Leitner and can be downloaded from
+ftrigger was written by Felix von Leitner and can be downloaded from
 .I http://www.fefe.de/minit/