From 670bdf20954c07711e211002fbd5e6c8e7a00622 Mon Sep 17 00:00:00 2001 From: ISSOtm Date: Mon, 9 Mar 2026 03:33:41 -0400 Subject: [PATCH] Document `run-tests.sh --os` Also switch to heredoc syntax for ease of editing --- test/fetch-test-deps.sh | 18 ++++++++++-------- test/run-tests.sh | 19 +++++++++++-------- 2 files changed, 21 insertions(+), 16 deletions(-) diff --git a/test/fetch-test-deps.sh b/test/fetch-test-deps.sh index 4cfcfae1..507446f9 100755 --- a/test/fetch-test-deps.sh +++ b/test/fetch-test-deps.sh @@ -4,14 +4,16 @@ set -euo pipefail cd "$(dirname "$0")" usage() { - echo "Downloads source code of Game Boy programs used as RGBDS test cases." - echo "Options:" - echo " -h, --help show this help message" - echo " --only-free download only freely licensed codebases" - echo " --only-internal do not download any codebases" - echo " --get-deps install programs' own dependencies instead of themselves" - echo " --get-hash print programs' commit hashes instead of downloading them" - echo " --get-paths print programs' GitHub paths instead of downloading them" + cat <<"EOF" +Downloads source code of Game Boy programs used as RGBDS test cases. +Options: + -h, --help show this help message + --only-free download only freely licensed codebases + --only-internal do not download any codebases + --get-deps install programs' own dependencies instead of themselves + --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 diff --git a/test/run-tests.sh b/test/run-tests.sh index f49e7436..3720d037 100755 --- a/test/run-tests.sh +++ b/test/run-tests.sh @@ -9,14 +9,17 @@ export SOURCE_DATE_EPOCH=609165296 cd "$(dirname "$0")" usage() { - echo "Runs regression tests on RGBDS." - echo "Options:" - echo " -h, --help show this help message" - echo " --only-internal only run tests that build local examples" - echo " --only-external only run tests that build external codebases" - echo " --only-free skip tests that build nonfree codebases" - echo " --installed-rgbds use the system installed RGBDS" - echo " (only compatible with external codebases)" + cat <<"EOF" +Runs regression tests on RGBDS. +Options: + -h, --help show this help message + --only-internal only run tests that build local examples + --only-external only run tests that build external codebases + --only-free skip tests that build nonfree codebases + --os skip tests known to fail on (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