]> Cypherpunks.ru repositories - gostls13.git/commitdiff
io/fs: godoc links to testing/fstest
authorOlivier Mengué <olivier.mengue@gmail.com>
Mon, 9 Oct 2023 20:36:01 +0000 (22:36 +0200)
committerDaniel MartĂ­ <mvdan@mvdan.cc>
Mon, 15 Jan 2024 21:21:41 +0000 (21:21 +0000)
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>
src/io/fs/fs.go

index d6c75c4cf43294be3c465a0a39f3fab53902cbcf..6891d75a0e838ad5f4b7cf97595af05d57a28214 100644 (file)
@@ -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.
        //