From: Antonio Ospite <ao2@ao2.it>
Date: Thu, 13 Dec 2018 22:54:36 +0000 (+0100)
Subject: populate-sparsely.sh: explain why the script exits if there is no lock
X-Git-Url: https://git.ao2.it/config/vcsh.git/commitdiff_plain/6f9082f6cf2b819ed8d1f9b7da825e546d3d8b4a?ds=sidebyside

populate-sparsely.sh: explain why the script exits if there is no lock

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.
---

diff --git a/.config/vcsh/hooks-available/populate-sparsely.sh b/.config/vcsh/hooks-available/populate-sparsely.sh
index 387ec21..53d2b3a 100755
--- a/.config/vcsh/hooks-available/populate-sparsely.sh
+++ b/.config/vcsh/hooks-available/populate-sparsely.sh
@@ -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
+
+# 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")