walk: update the comment
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
parent
f165f4b7cc
commit
eca64ff621
1 changed files with 4 additions and 3 deletions
7
walk.go
7
walk.go
|
@ -25,9 +25,10 @@ var ExcludeNonDirectories = func(path string, info os.FileInfo) bool {
|
||||||
|
|
||||||
var defaultSetKeywords = []KeyVal{"type=file", "nlink=1", "flags=none", "mode=0664"}
|
var defaultSetKeywords = []KeyVal{"type=file", "nlink=1", "flags=none", "mode=0664"}
|
||||||
|
|
||||||
// Walk from root directory and assemble the DirectoryHierarchy. excludes
|
// Walk from root directory and assemble the DirectoryHierarchy
|
||||||
// provided are used to skip paths. keywords are the set to collect from the
|
// * `excludes` provided are used to skip paths
|
||||||
// walked paths. The recommended default list is DefaultKeywords.
|
// * `keywords` are the set to collect from the walked paths. The recommended default list is DefaultKeywords.
|
||||||
|
// * `fsEval` is the interface to use in evaluating files. If `nil`, then DefaultFsEval is used.
|
||||||
func Walk(root string, excludes []ExcludeFunc, keywords []Keyword, fsEval FsEval) (*DirectoryHierarchy, error) {
|
func Walk(root string, excludes []ExcludeFunc, keywords []Keyword, fsEval FsEval) (*DirectoryHierarchy, error) {
|
||||||
if fsEval == nil {
|
if fsEval == nil {
|
||||||
fsEval = DefaultFsEval{}
|
fsEval = DefaultFsEval{}
|
||||||
|
|
Loading…
Reference in a new issue