aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2005-05-06 13:08:15 +0000
committerEli Zaretskii2005-05-06 13:08:15 +0000
commitc7c4bc11b1dbc9e17919788a409cd3ceb120f615 (patch)
tree385552fce8b242103ab7f442b19803a99a41bc72
parent57a131fbc05820ea8afe802d61a95d6a0a2f4a09 (diff)
downloademacs-c7c4bc11b1dbc9e17919788a409cd3ceb120f615.tar.gz
emacs-c7c4bc11b1dbc9e17919788a409cd3ceb120f615.zip
(locate-file): Doc fix.
-rw-r--r--lisp/files.el5
1 files changed, 5 insertions, 0 deletions
diff --git a/lisp/files.el b/lisp/files.el
index ea4799968fe..e74e1adcf3d 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -632,8 +632,13 @@ The path separator is colon in GNU and GNU-like systems."
632 632
633(defun locate-file (filename path &optional suffixes predicate) 633(defun locate-file (filename path &optional suffixes predicate)
634 "Search for FILENAME through PATH. 634 "Search for FILENAME through PATH.
635If found, return the absolute file name of FILENAME, with its suffixes;
636otherwise return nil.
637PATH should be a list of directories to look in, like the lists in
638`exec-path' or `load-path'.
635If SUFFIXES is non-nil, it should be a list of suffixes to append to 639If SUFFIXES is non-nil, it should be a list of suffixes to append to
636file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). 640file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\").
641Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
637If non-nil, PREDICATE is used instead of `file-readable-p'. 642If non-nil, PREDICATE is used instead of `file-readable-p'.
638PREDICATE can also be an integer to pass to the `access' system call, 643PREDICATE can also be an integer to pass to the `access' system call,
639in which case file-name handlers are ignored. This usage is deprecated. 644in which case file-name handlers are ignored. This usage is deprecated.