summaryrefslogtreecommitdiffstats
path: root/test/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
new file mode 100644
index 0000000..1d37f2d
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,19 @@
+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:
+
+ ../bin/go test cmd/internal/testdir
+
+To run just tests from specified files in this directory, execute:
+
+ ../bin/go test cmd/internal/testdir -run='Test/(file1.go|file2.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.