aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Bleecher Snyder <josharian@gmail.com>2017-07-24 10:17:15 -0700
committerJosh Bleecher Snyder <josharian@gmail.com>2017-07-26 23:37:25 +0000
commite157fac02d4700e9fa8e1c30265a2d90a51be6f3 (patch)
treea1fe6e4245d9cecbd45a235b5de01ed28e4d179c
parent835dfef939879b284d4c0f4e1726491f27e4f1ee (diff)
downloadgo-e157fac02d4700e9fa8e1c30265a2d90a51be6f3.tar.gz
go-e157fac02d4700e9fa8e1c30265a2d90a51be6f3.zip
test: add README
Updates #21034 Change-Id: I951fb48ab3b9ed54d225c11879db8f09048a36a3 Reviewed-on: https://go-review.googlesource.com/50950 Reviewed-by: Rob Pike <r@golang.org>
-rw-r--r--test/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000000..ca6a8c6580
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,15 @@
+The test directory contains tests of the Go tool chain and runtime.
+It includes black box tests, regression tests, and error output tests.
+They are run as part of all.bash.
+
+To run just these tests, execute:
+
+ go run run.go
+
+Standard library tests should be written as regular Go tests in the appropriate package.
+
+The tool chain and runtime also have regular Go tests in their packages.
+The main reasons to add a new test to this directory are:
+
+* it is most naturally expressed using the test runner; or
+* it is also applicable to `gccgo` and other Go tool chains.