Skip to content

Commit 7d3253f

Browse files
committed
update docs
1 parent 0a87545 commit 7d3253f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

pkg/manifests/util.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ func fileTypeFromMode(mode fs.FileMode) uint {
8484
return fileType
8585
}
8686

87+
// Search fsys for all files under dir matching namePattern and fileType.
88+
// Resulting paths will be always relative to fsys (cleaned, with no leading dot).
89+
// The parameter dir must not contain any dot or double dot, unless it equals '.' in which case the whole fsys will be searched.
90+
// As an alternative, dir can be empty (which is equivalent to dir == '.').
91+
// The parameter maxDepth can be any integer between 0 and 10000 (where 0 is interpreted as 10000).
8792
func find(fsys fs.FS, dir string, namePattern string, fileType uint, maxDepth uint) ([]string, error) {
8893
if dir == "" {
8994
dir = "."

0 commit comments

Comments
 (0)