From 3ce643e6da859bec06b76c510d8a3cf25e6e5ae1 Mon Sep 17 00:00:00 2001
From: risk danger olson <technoweenie@gmail.com>
Date: Wed, 23 Nov 2016 13:33:07 -0700
Subject: [PATCH] update comments

---
 tools/filetools.go | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)

diff --git a/tools/filetools.go b/tools/filetools.go
index e6b79a48..0b804eaf 100644
--- a/tools/filetools.go
+++ b/tools/filetools.go
@@ -126,23 +126,17 @@ func VerifyFileHash(oid, path string) error {
 	return nil
 }
 
-// Returned from FastWalk with parent directory context
-// This is needed because FastWalk can provide paths out of order so the
-// parent dir cannot be implied
-type fastWalkInfo struct {
-	ParentDir string
-	Info      os.FileInfo
-}
-
+// FastWalkCallback is the signature for the callback given to FastWalkGitRepo()
 type FastWalkCallback func(parentDir string, info os.FileInfo, err error)
 
-// FastWalkGitRepo is a more optimal implementation of filepath.Walk for a Git repo
+// FastWalkGitRepo is a more optimal implementation of filepath.Walk for a Git
+// repo. The callback guaranteed to be called sequentially. The function returns
+// once all files and errors have triggered callbacks.
 // It differs in the following ways:
-//  * Provides a channel of information instead of using a callback func
 //  * Uses goroutines to parallelise large dirs and descent into subdirs
 //  * Does not provide sorted output; parents will always be before children but
-//    there are no other guarantees. Use parentDir in the fastWalkInfo struct to
-//    determine absolute path rather than tracking it yourself like filepath.Walk
+//    there are no other guarantees. Use parentDir argument in the callback to
+//    determine absolute path rather than tracking it yourself
 //  * Automatically ignores any .git directories
 //  * Respects .gitignore contents and skips ignored files/dirs
 func FastWalkGitRepo(dir string, cb FastWalkCallback) {
@@ -169,6 +163,14 @@ func FastWalkGitRepo(dir string, cb FastWalkCallback) {
 	wg.Wait()
 }
 
+// Returned from FastWalk with parent directory context
+// This is needed because FastWalk can provide paths out of order so the
+// parent dir cannot be implied
+type fastWalkInfo struct {
+	ParentDir string
+	Info      os.FileInfo
+}
+
 // fastWalkWithExcludeFiles walks the contents of a dir, respecting
 // include/exclude patterns and also loading new exlude patterns from files
 // named excludeFilename in directories walked