From 5c594f4fb33156a7f4084f3a21750ffaaf6074df Mon Sep 17 00:00:00 2001
From: Tom Ryder <tom@sanctum.geek.nz>
Date: Mon, 2 Jan 2017 20:08:32 +1300
Subject: Add comments to loc(1df)

---
 bin/loc | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'bin/loc')

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
-- 
cgit v1.2.3