Document run-tests.sh --os

Also switch to heredoc syntax for ease of editing
This commit is contained in:
ISSOtm
2026-03-09 03:33:41 -04:00
committed by Rangi
parent 6270f654a1
commit 670bdf2095
2 changed files with 21 additions and 16 deletions

View File

@@ -4,14 +4,16 @@ set -euo pipefail
cd "$(dirname "$0")" cd "$(dirname "$0")"
usage() { usage() {
echo "Downloads source code of Game Boy programs used as RGBDS test cases." cat <<"EOF"
echo "Options:" Downloads source code of Game Boy programs used as RGBDS test cases.
echo " -h, --help show this help message" Options:
echo " --only-free download only freely licensed codebases" -h, --help show this help message
echo " --only-internal do not download any codebases" --only-free download only freely licensed codebases
echo " --get-deps install programs' own dependencies instead of themselves" --only-internal do not download any codebases
echo " --get-hash print programs' commit hashes instead of downloading them" --get-deps install programs' own dependencies instead of themselves
echo " --get-paths print programs' GitHub paths instead of downloading them" --get-hash print programs' commit hashes instead of downloading them
--get-paths print programs' GitHub paths instead of downloading them
EOF
} }
# Parse options in pure Bash because macOS `getopt` is stuck # Parse options in pure Bash because macOS `getopt` is stuck

View File

@@ -9,14 +9,17 @@ export SOURCE_DATE_EPOCH=609165296
cd "$(dirname "$0")" cd "$(dirname "$0")"
usage() { usage() {
echo "Runs regression tests on RGBDS." cat <<"EOF"
echo "Options:" Runs regression tests on RGBDS.
echo " -h, --help show this help message" Options:
echo " --only-internal only run tests that build local examples" -h, --help show this help message
echo " --only-external only run tests that build external codebases" --only-internal only run tests that build local examples
echo " --only-free skip tests that build nonfree codebases" --only-external only run tests that build external codebases
echo " --installed-rgbds use the system installed RGBDS" --only-free skip tests that build nonfree codebases
echo " (only compatible with external codebases)" --os <os> skip tests known to fail on <os> (e.g. `macos-14`)
--installed-rgbds use the system installed RGBDS
(only compatible with external codebases)
EOF
} }
# Parse options in pure Bash because macOS `getopt` is stuck # Parse options in pure Bash because macOS `getopt` is stuck