From 65c0882672977684ba005e98821f26da4944f1f1 Mon Sep 17 00:00:00 2001
From: Andrew Ruthven <andrew@etc.gen.nz>
Date: Sun, 24 Jan 2021 18:56:43 +1300
Subject: [PATCH] Add help option for regression tests

---
 testing/README.regression_tests |  1 +
 testing/run_regressions.sh      | 19 ++++++++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/testing/README.regression_tests b/testing/README.regression_tests
index a9aae3e4..0360008c 100644
--- a/testing/README.regression_tests
+++ b/testing/README.regression_tests
@@ -119,6 +119,7 @@ the options being
   e = edit test (vi)
   r = re-run test
   N = run next test
+  ? = Show options
 
 This should allow for convenient updating of tests and expected results.
 
diff --git a/testing/run_regressions.sh b/testing/run_regressions.sh
index f2cd1bdb..36a7c647 100755
--- a/testing/run_regressions.sh
+++ b/testing/run_regressions.sh
@@ -70,7 +70,7 @@ check_result() {
        echo "======================================="
     fi
     if [ "${ACCEPT_ALL}" = "" ] ; then
-      read -p "[${TEST}] Accept new result [e/s/r/v/f/m/x/y/w/N]? " ACCEPT
+      read -p "[${TEST}] Accept new result [e/s/r/v/f/m/x/y/w/N/?]? " ACCEPT
     else
       ACCEPT=${ACCEPT_ALL}
     fi
@@ -108,6 +108,23 @@ check_result() {
     elif [ "${ACCEPT}" = "r" ]; then
       echo "Rerunning test ${TEST}"
       return 1
+    elif [ "${ACCEPT}" = "?" ]; then
+      cat <<EOF
+Options:
+
+  e = edit test (vi)
+  f = show full details of test and result
+  m = side-by-side 'meld'
+  N = run next test (default)
+  r = re-run test
+  s = side-by-side diff of actual and expected result
+  v = show test
+  w = colourized wdiff
+  x = print command for running test in debug mode and exit testing
+  y = make new result the expected result
+
+EOF
+      return 3
     fi
   else
     report_test_success