From: =?utf-8?b?T25kxZllaiBLdXpuw61r?= <ondra@mistotebe.net>
Date: Tue, 6 Aug 2019 16:34:35 +0000
Subject: Should document that files are handled by their inodes

Debian-Bug: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=594163
---
 man/inotifywait.1  | 8 ++++++++
 man/inotifywatch.1 | 9 +++++++++
 2 files changed, 17 insertions(+)

diff --git a/man/inotifywait.1 b/man/inotifywait.1
index 9c43ca0..b9a39d6 100644
--- a/man/inotifywait.1
+++ b/man/inotifywait.1
@@ -332,6 +332,14 @@ CLOSE_WRITE:CLOSE goodfile
 DELETE badfile
 .fi
 
+.SH CAVEATS
+
+When using inotifywait, the filename that is outputted is not
+guaranteed to be up to date after a move because it is the inode that
+is being monitored. Additionally, none of the observed operations are
+guaranteed to have been performed on the filename inotifywait was
+instructed to monitor in cases when the file is known by several names
+in the filesystem.
 
 .SH BUGS
 There are race conditions in the recursive directory watching code
diff --git a/man/inotifywatch.1 b/man/inotifywatch.1
index ee5571c..0e0c22c 100644
--- a/man/inotifywatch.1
+++ b/man/inotifywatch.1
@@ -254,6 +254,15 @@ total  access  modify  filename
 2      2       0       /home/rohan/.beagle/Indexes/KMailIndex/SecondaryIndex/
 .fi
 
+.SH CAVEATS
+
+When using inotifywatch, the filename that is outputted is not
+guaranteed to be up to date after a move because it is the inode that
+is being monitored. Additionally, none of the observed operations are
+guaranteed to have been performed on the filename inotifywatch was
+instructed to monitor in cases when the file is known by several names
+in the filesystem.
+
 .SH BUGS
 There are race conditions in the recursive directory watching code
 which can cause events to be missed if they occur in a directory immediately
