code review 7304043: path/filepath: document that Walk does not follow symlinks

src/pkg/path/filepath/path.go

 // Copyright 2009 The Go Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
 // Package filepath implements utility routines for manipulating filename paths
 // in a way compatible with the target operating system-defined file paths.
 package filepath
 
 import (
         "errors"
@@ skipping 356 matching lines @@
                 }
         }
         return nil
 }
 
 // Walk walks the file tree rooted at root, calling walkFn for each file or
 // directory in the tree, including root. All errors that arise visiting files
 // and directories are filtered by walkFn. The files are walked in lexical
 // order, which makes the output deterministic but means that for very
 // large directories Walk can be inefficient.
+// Walk does not follow symbolic links.
 func Walk(root string, walkFn WalkFunc) error {
         info, err := os.Lstat(root)
         if err != nil {
                 return walkFn(root, nil, err)
         }
         return walk(root, info, walkFn)
 }
 
 // readDir reads the directory named by dirname and returns
 // a sorted list of directory entries.
@@ skipping 70 matching lines @@
         return vol + dir
 }
 
 // VolumeName returns leading volume name.
 // Given "C:\foo\bar" it returns "C:" under windows.
 // Given "\\host\share\foo" it returns "\\host\share".
 // On other platforms it returns "".
 func VolumeName(path string) (v string) {
         return path[:volumeNameLen(path)]
 }