aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Mengué <olivier.mengue@gmail.com>2023-10-09 22:36:01 +0200
committerDaniel MartĂ­ <mvdan@mvdan.cc>2024-01-15 21:21:41 +0000
commitb44f6378233ada888f0dc79e0ac56def4673d9ed (patch)
treee48fa6aba1e932dc29bb811ef286a05a90755e5f
parent202b4359696bcd2945244b42299e35e338331019 (diff)
downloadgo-b44f6378233ada888f0dc79e0ac56def4673d9ed.tar.gz
go-b44f6378233ada888f0dc79e0ac56def4673d9ed.zip
io/fs: godoc links to testing/fstest
Add godoc links from io/fs to testing/fstest for discoverability. Change-Id: I6550b4b703d2214faa732987ec8630ac903705b5 Reviewed-on: https://go-review.googlesource.com/c/go/+/534095 Reviewed-by: Michael Knyszek <mknyszek@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Bryan Mills <bcmills@google.com>
-rw-r--r--src/io/fs/fs.go6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/io/fs/fs.go b/src/io/fs/fs.go
index d6c75c4cf4..6891d75a0e 100644
--- a/src/io/fs/fs.go
+++ b/src/io/fs/fs.go
@@ -5,6 +5,9 @@
// Package fs defines basic interfaces to a file system.
// A file system can be provided by the host operating system
// but also by other packages.
+//
+// See the [testing/fstest] package for support with testing
+// implementations of file systems.
package fs
import (
@@ -18,6 +21,9 @@ import (
// The FS interface is the minimum implementation required of the file system.
// A file system may implement additional interfaces,
// such as [ReadFileFS], to provide additional or optimized functionality.
+//
+// [testing/fstest.TestFS] may be used to test implementations of an FS for
+// correctness.
type FS interface {
// Open opens the named file.
//