From a65c8070a021e97718aa33f8c599c1756774753c Mon Sep 17 00:00:00 2001
From: Oleg Alexandrov <oleg.alexandrov@gmail.com>
Date: Thu, 28 Sep 2023 09:04:21 -0700
Subject: [PATCH] Add a note in the workflow

---
 .github/workflows/build_test.sh | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/build_test.sh b/.github/workflows/build_test.sh
index f2b1daef3..952cdf2c4 100755
--- a/.github/workflows/build_test.sh
+++ b/.github/workflows/build_test.sh
@@ -79,7 +79,8 @@ if [ ! -d "$binDir" ]; then
     exit 1
 fi
 
-# Extract the tests
+# Extract the tests. This tarball has both the scripts, test data,
+# and the expected results.
 cd $baseDir
 wget https://github.com/NeoGeographyToolkit/StereoPipelineTest/releases/download/0.0.1/StereoPipelineTest.tar  > /dev/null 2>&1 # this is verbose
 tar xfv StereoPipelineTest.tar > /dev/null 2>&1 # this is verbose
@@ -102,6 +103,9 @@ for d in ss*; do
     cd $d
     pwd
     ./run.sh > /dev/null 2>&1
+    # TODO(oalexan1): The validate.sh script can print a lot of verbose text.
+    # Add a pipe to the head function. Then use ${PIPESTATUS[0]} to find the
+    # exit code of this script.
     ./validate.sh
     ans0=$?
     echo "Test $d returned $ans0"