Add comments to loc(1df)

1 files changed, 8 insertions, 0 deletions

diff --git a/bin/loc b/bin/loc
index 7f4ac1fa..16d355f2 100755
--- a/bin/loc
+++ b/bin/loc
@@ -1,9 +1,17 @@
 #!/bin/sh
+# Convenience find(1) wrapper for path substrings
+
+# Require at least one search term
 if [ "$#" -eq 0 ] ; then
     printf >&2 'loc: Need a search term\n'
     exit 2
 fi
+
+# Iterate through each search term and run an appropriate find(1) command
 for pat ; do
+
+    # Skip dotfiles and dotdirs, print anything that matches the term as a
+    # substring (and stop iterating through it)
     find . \
         -name .\* ! -name . -prune -o \
         -name \*"$pat"\* -prune -print