]> git.eshelyaron.com Git - emacs.git/commitdiff
lisp/files.el (file-tree-walk): Doc fix.
authorEli Zaretskii <eliz@gnu.org>
Thu, 4 Dec 2014 07:58:19 +0000 (09:58 +0200)
committerEli Zaretskii <eliz@gnu.org>
Thu, 4 Dec 2014 07:58:19 +0000 (09:58 +0200)
lisp/ChangeLog
lisp/files.el

index 819e0d0a1b21e9a8181a05a09a7e5665b4ba8e90..9c729bc936f1611e45b5d781e1425b8b33046e42 100644 (file)
@@ -1,3 +1,7 @@
+2014-12-04  Eli Zaretskii  <eliz@gnu.org>
+
+       * files.el (file-tree-walk): Doc fix.
+
 2014-12-04  Rupert Swarbrick  <ruperts@broadcom.com> (tiny change)
            RĂ¼diger Sonderfeld  <ruediger@c-plusplus.net>
 
index 740a00a41e3c2ca51c151be6fa8f41bbf5ce7c40..0f54a22d61e2d2e71a883f91f484e842dcf5cd29 100644 (file)
@@ -730,10 +730,17 @@ The path separator is colon in GNU and GNU-like systems."
        (error "No such directory found via CDPATH environment variable"))))
 
 (defun file-tree-walk (dir action &rest args)
-  "Walk DIR executing ACTION on each path, with ARGS as additional arguments.
-Each call gets as arguments DIR, a file path, and optional ARGS.
+  "Walk DIR executing ACTION on each file, with ARGS as additional arguments.
+For each file, the function calls ACTION as follows:
+
+   \(ACTION DIRECTORY BASENAME ARGS\)
+
+Where DIRECTORY is the leading directory of the file,
+      BASENAME is the basename of the file,
+      and ARGS are as specified in the call to this function, or nil if omitted.
+
 The ACTION is applied to each subdirectory before descending into
-it, and if nil is returned at that point the descent will be
+it, and if nil is returned at that point, the descent will be
 prevented.  Directory entries are sorted with string-lessp."
   (cond ((file-directory-p dir)
         (or (char-equal ?/ (aref dir (1- (length dir))))