aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/internal/script/scripttest/doc.go
diff options
context:
space:
mode:
authorThan McIntosh <thanm@google.com>2024-07-25 17:15:35 +0000
committerThan McIntosh <thanm@google.com>2024-07-29 16:13:04 +0000
commit0d8aa5737ecdc03b2723a2af35cb7394335e5411 (patch)
tree91e075eec22ec01378f117a17c454f97ad93f71d /src/cmd/internal/script/scripttest/doc.go
parent32b55eda5e6956e7ee2f913ae79e1e2a3414c9ed (diff)
downloadgo-0d8aa5737ecdc03b2723a2af35cb7394335e5411.tar.xz
cmd/internal/script/scriptest: add new apis for tool test use
Add top level apis to provide a general-purpose "script test" runner for clients within cmd, e.g. tools such as compile, link, nm, and so on. This patch doesn't add any uses of the new apis, this will happen in follow-on CLs. Updates #68606. Change-Id: Ib7200a75d4dc7dc50897628f1a6269937be15a76 Reviewed-on: https://go-review.googlesource.com/c/go/+/601359 Reviewed-by: David Chase <drchase@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Cherry Mui <cherryyz@google.com>
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.