mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Document locate-dominating-file

Browse source 
* doc/lispref/files.texi (Contents of Directories): Document
locate-dominating-file (bug#33869).
This commit is contained in:
Lars Ingebrigtsen 2019-10-13 00:22:03 +02:00
parent 914b98a1c6
commit 5fffed6e88
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
doc/lispref/files.texi
View file

@ -2924,6 +2924,7 @@ that can be read.
@end defun
@defun directory-files-recursively directory regexp &optional include-directories predicate follow-symlinks
@cindex recursing downwards in directories
Return all files under @var{directory} whose names match @var{regexp}.
This function searches the specified @var{directory} and its
sub-directories, recursively, for files whose basenames (i.e., without
@ -2949,6 +2950,19 @@ Symbolic links to subdirectories are not followed by default, but if
@var{follow-symlinks} is non-@code{nil}, they are followed.
@end defun
@defun locate-dominating-file file name
@cindex recursing upwards in directories
Starting at @var{file}, recurse up the directory hierarchy looking for
the first directory where @var{name} exists, which is then the return
value of this function. @var{file} can be a file or a directory. If
it's a file, its directory will serve as the starting point for
searching the hierarchy of directories.
@code{name} can be either a string or a predicate. The predicate
takes one argument (the directory) and should return non-@code{nil} if
we've found the directory we're looking for.
@end defun
@defun directory-files-and-attributes directory &optional full-name match-regexp nosort id-format
This is similar to @code{directory-files} in deciding which files
to report on and how to report their names. However, instead