From 452e5c1c597cb87b79a68c48809bd589bf7bd9d6 Mon Sep 17 00:00:00 2001
From: Jean-Francois Dockes <jfd@recoll.org>
Date: Mon, 16 Nov 2015 09:26:19 +0100
Subject: [PATCH] comments

---
 src/filters/rclcheckneedretry.sh | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/src/filters/rclcheckneedretry.sh b/src/filters/rclcheckneedretry.sh
index 8db4c518..4d9e3ccc 100755
--- a/src/filters/rclcheckneedretry.sh
+++ b/src/filters/rclcheckneedretry.sh
@@ -1,14 +1,21 @@
 #!/bin/sh
 
-# Check /usr/bin and /usr/local/bin modification date against recorded
-# state, as recorded inside ~/.config/Recoll.org/needidxretrydate
+# This script is called by recollindex to determine if it would be
+# worth retrying files which previously failed to index.
+#
+# This is the default implementation, it is pointed to by the
+# 'checkneedretryindexscript' variable in the default recoll.conf
+#
+# The script exits with 0 if retrying should be performed (something
+# changed), 1 else.
+#
+# We check /usr/bin and /usr/local/bin modification date against the
+# previous value recorded inside ~/.config/Recoll.org/needidxretrydate
 #
 # If any argument is given, we record the new state instead of
 # generating it (this should be used at the end of an indexing pass
 # with retry set).
 #
-# The script exits with 0 if retrying should be performed (something
-# changed), 1 else.
 
 # Bin dirs to be tested:
 bindirs="/usr/bin /usr/local/bin $HOME/bin /opt/*/bin"