From: Chris Koeritz <fred@gruntose.com>
Date: Fri, 1 Jun 2018 16:59:42 +0000 (-0400)
Subject: better instructions for rounder
X-Git-Tag: 2.140.114^2~18
X-Git-Url: https://feistymeow.org/gitweb/?p=feisty_meow.git;a=commitdiff_plain;h=3232e15a9e8f08cd0fe1165ddf017733704c0c20

better instructions for rounder
---

diff --git a/scripts/testing/rounder.sh b/scripts/testing/rounder.sh
index 3214ee68..797dfbb8 100644
--- a/scripts/testing/rounder.sh
+++ b/scripts/testing/rounder.sh
@@ -6,7 +6,19 @@
 test_to_run="$1"
 
 if [ -z "$test_to_run" ]; then
-  echo "This script requires a test or program to run as the first parameter."
+  echo "
+rounder: this script requires a test or program to run as the first parameter.
+
+the parameter can be an arbitrarily complex bash command as long as it's
+escaped properly.  for example, this command will check a directory size and
+then sleep for 10 seconds:
+
+  rounder  '\du -s ~/a_folder_i_watch; sleep 10'
+
+rounder will run this check, snoozing in between checks, until the universe
+ends or something intervenes.  note that without the sleep, the check would
+occur very rapidly and spew output.
+"
   exit 1
 fi