changeset 62117:11d8a39e986e

(locate-file): Doc fix.
author Eli Zaretskii <eliz@gnu.org>
date Fri, 06 May 2005 13:08:15 +0000
parents f1b7fe92d96a
children e5a04a0e92c1
files lisp/files.el
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/files.el	Fri May 06 13:00:53 2005 +0000
+++ b/lisp/files.el	Fri May 06 13:08:15 2005 +0000
@@ -632,8 +632,13 @@
 
 (defun locate-file (filename path &optional suffixes predicate)
   "Search for FILENAME through PATH.
+If found, return the absolute file name of FILENAME, with its suffixes;
+otherwise return nil.
+PATH should be a list of directories to look in, like the lists in
+`exec-path' or `load-path'.
 If SUFFIXES is non-nil, it should be a list of suffixes to append to
 file name when searching.  If SUFFIXES is nil, it is equivalent to '(\"\").
+Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES.
 If non-nil, PREDICATE is used instead of `file-readable-p'.
 PREDICATE can also be an integer to pass to the `access' system call,
 in which case file-name handlers are ignored.  This usage is deprecated.