lisp/files.el (file-tree-walk): Doc fix.

This commit is contained in:
Eli Zaretskii 2014-12-04 09:58:19 +02:00
parent a0363ffa99
commit 2bef807c32
2 changed files with 14 additions and 3 deletions

View 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>

View 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))))