emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] master 2bef807: lisp/files.el (file-tree-walk): Doc fix.


From: Eli Zaretskii
Subject: [Emacs-diffs] master 2bef807: lisp/files.el (file-tree-walk): Doc fix.
Date: Thu, 04 Dec 2014 07:58:49 +0000

branch: master
commit 2bef807c322b44cf63db85e4b60001a76cbe3d9f
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    lisp/files.el (file-tree-walk): Doc fix.
---
 lisp/ChangeLog |    4 ++++
 lisp/files.el  |   13 ++++++++++---
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 819e0d0..9c729bc 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2014-12-04  Eli Zaretskii  <address@hidden>
+
+       * files.el (file-tree-walk): Doc fix.
+
 2014-12-04  Rupert Swarbrick  <address@hidden> (tiny change)
            RĂ¼diger Sonderfeld  <address@hidden>
 
diff --git a/lisp/files.el b/lisp/files.el
index 740a00a..0f54a22 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -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))))



reply via email to

[Prev in Thread] Current Thread [Next in Thread]