From: Eli Zaretskii Date: Thu, 4 Dec 2014 07:58:19 +0000 (+0200) Subject: lisp/files.el (file-tree-walk): Doc fix. X-Git-Tag: emacs-25.0.90~2635^2~208 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=2bef807c322b44cf63db85e4b60001a76cbe3d9f;p=emacs.git lisp/files.el (file-tree-walk): Doc fix. --- diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 819e0d0a1b2..9c729bc936f 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,7 @@ +2014-12-04 Eli Zaretskii + + * files.el (file-tree-walk): Doc fix. + 2014-12-04 Rupert Swarbrick (tiny change) Rüdiger Sonderfeld diff --git a/lisp/files.el b/lisp/files.el index 740a00a41e3..0f54a22d61e 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))))