aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/internal/script/scripttest/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/internal/script/scripttest/doc.go')
-rw-r--r--src/cmd/internal/script/scripttest/doc.go17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/cmd/internal/script/scripttest/doc.go b/src/cmd/internal/script/scripttest/doc.go
new file mode 100644
index 0000000000..0ad6d69639
--- /dev/null
+++ b/src/cmd/internal/script/scripttest/doc.go
@@ -0,0 +1,17 @@
+// Copyright 2022 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// Package scripttest adapts the script engine for use in tests.
+package scripttest
+
+// This package provides APIs for executing "script" tests; this
+// way of writing Go tests originated with the Go command, and has
+// since been generalized to work with other commands, such as the
+// compiler, linker, and other tools.
+//
+// The top level entry point for this package is "Test", which
+// accepts a previously configured script engine and pattern (typically
+// by convention this will be "testdata/script/*.txt")
+// then kicks off the engine on each file that matches the
+// pattern.