aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDmitri Shuralyov <dmitshur@golang.org>2022-12-02 13:30:06 -0500
committerGopher Robot <gobot@golang.org>2022-12-06 19:52:35 +0000
commit03bf6f4917c1c8cd883dfa1618b90a95b9192f9a (patch)
treeea505d522e56af25dccd07ee48e6ebc4bb68dced
parentdfd13ce59d74638baff4f94d64851cda53e63bdc (diff)
downloadgo-03bf6f4917c1c8cd883dfa1618b90a95b9192f9a.tar.gz
go-03bf6f4917c1c8cd883dfa1618b90a95b9192f9a.zip
run.bash, cmd/dist: document GO_TEST_SHORT and GO_TEST_TIMEOUT_SCALE
These environment variables affect cmd/dist, and in turn run.bash. They exist primarily for the Go build system, but are still needed sometimes when investigating problems. Document them in one place. Fixes #46054. Change-Id: I5dea2ac79b0d203d2f3c9ec2980382f62bead5cd Reviewed-on: https://go-review.googlesource.com/c/go/+/455517 Auto-Submit: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
-rw-r--r--src/cmd/dist/test.go6
-rwxr-xr-xsrc/run.bash9
2 files changed, 9 insertions, 6 deletions
diff --git a/src/cmd/dist/test.go b/src/cmd/dist/test.go
index 722aa0868b..9f2660631d 100644
--- a/src/cmd/dist/test.go
+++ b/src/cmd/dist/test.go
@@ -102,12 +102,6 @@ func (t *tester) run() {
os.Setenv("PATH", fmt.Sprintf("%s%c%s", gorootBin, os.PathListSeparator, os.Getenv("PATH")))
- // Default to running tests in "short" mode, unless the environment variable
- // GO_TEST_SHORT is set to a non-empty, false-ish string.
- //
- // This environment variable is meant to be an internal detail between the
- // Go build system and cmd/dist for the purpose of longtest builders, and is
- // not intended for use by users. See golang.org/issue/12508.
t.short = true
if v := os.Getenv("GO_TEST_SHORT"); v != "" {
short, err := strconv.ParseBool(v)
diff --git a/src/run.bash b/src/run.bash
index 4f4d437365..35fa8f626c 100755
--- a/src/run.bash
+++ b/src/run.bash
@@ -13,6 +13,15 @@
# GO_BUILDER_NAME: the name of the Go builder that's running the tests.
# Some tests are conditionally enabled or disabled based on the builder
# name or the builder name being non-empty.
+#
+# GO_TEST_SHORT: if set to a non-empty, false-ish string, run tests in "-short=false" mode.
+# This environment variable is an internal implementation detail between the
+# Go build system (x/build) and cmd/dist for the purpose of longtest builders,
+# and will be removed if it stops being needed. See go.dev/issue/12508.
+#
+# GO_TEST_TIMEOUT_SCALE: a non-negative integer factor to scale test timeout by.
+# Defaults to 1, or as a special case for the purpose of the Go build system (x/build),
+# defaults to 2 when GOARCH is arm, and to 4 when GOARCH is mips, mipsle, mips64, or mips64le.
set -e