populate-sparsely.sh: explain why the script exits if there is no lock
authorAntonio Ospite <ao2@ao2.it>
Thu, 13 Dec 2018 22:54:36 +0000 (23:54 +0100)
committerAntonio Ospite <ao2@ao2.it>
Mon, 17 Dec 2018 09:35:44 +0000 (10:35 +0100)
The reason why the script exits if there is no lock was given in the
commit message when the check was added, but reading the code after some
time I could not remember it, so just put the explanation in a comment
to make the life easier for the reader.

.config/vcsh/hooks-available/populate-sparsely.sh

index 387ec21..53d2b3a 100755 (executable)
@@ -5,6 +5,9 @@ set -e
 # Only the same instance of vcsh that had the working tree fully populated is
 # allowed to repopulate it sparsely.
 LOCKDIR=/run/lock/vcsh
 # Only the same instance of vcsh that had the working tree fully populated is
 # allowed to repopulate it sparsely.
 LOCKDIR=/run/lock/vcsh
+
+# If LOCKDIR does not exist it means that the lock is not active so there's no
+# need to do anything.
 [ -d "$LOCKDIR" ] || exit 0
 
 LOCKPID=$(cat "$LOCKDIR/pid")
 [ -d "$LOCKDIR" ] || exit 0
 
 LOCKPID=$(cat "$LOCKDIR/pid")