os: document DirFS implements fs.StatFS

hopehook · ianlancetaylor · commit b0750de65660 · 2022-03-26T23:18:20.000Z
Fixes golang#51856 Change-Id: I8328d73bbb7bc166d58281180b64785a634e9bab Reviewed-on: https://go-review.googlesource.com/c/go/+/394555 Reviewed-by: Ian Lance Taylor <iant@golang.org> Trust: Daniel Martí <mvdan@mvdan.cc> Run-TryBot: Daniel Martí <mvdan@mvdan.cc> TryBot-Result: Gopher Robot <gobot@golang.org>
diff --git a/src/os/file.go b/src/os/file.go
@@ -623,6 +623,8 @@ func isWindowsNulName(name string) bool {
 // the /prefix tree, then using DirFS does not stop the access any more than using
 // os.Open does. DirFS is therefore not a general substitute for a chroot-style security
 // mechanism when the directory tree contains arbitrary content.
+//
+// The result implements fs.StatFS.
 func DirFS(dir string) fs.FS {
 	return dirFS(dir)
 }

Original file line number	Diff line number	Diff line change
`@@ -623,6 +623,8 @@ func isWindowsNulName(name string) bool {`
`623`	`623`	`// the /prefix tree, then using DirFS does not stop the access any more than using`
`624`	`624`	`// os.Open does. DirFS is therefore not a general substitute for a chroot-style security`
`625`	`625`	`// mechanism when the directory tree contains arbitrary content.`
	`626`	`+//`
	`627`	`+// The result implements fs.StatFS.`
`626`	`628`	`func DirFS(dir string) fs.FS {`
`627`	`629`	`return dirFS(dir)`
`628`	`630`	`}`