diff options
| author | Eli Zaretskii | 2005-05-06 13:08:15 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2005-05-06 13:08:15 +0000 |
| commit | c7c4bc11b1dbc9e17919788a409cd3ceb120f615 (patch) | |
| tree | 385552fce8b242103ab7f442b19803a99a41bc72 | |
| parent | 57a131fbc05820ea8afe802d61a95d6a0a2f4a09 (diff) | |
| download | emacs-c7c4bc11b1dbc9e17919788a409cd3ceb120f615.tar.gz emacs-c7c4bc11b1dbc9e17919788a409cd3ceb120f615.zip | |
(locate-file): Doc fix.
| -rw-r--r-- | lisp/files.el | 5 |
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. |
| 635 | If found, return the absolute file name of FILENAME, with its suffixes; | ||
| 636 | otherwise return nil. | ||
| 637 | PATH should be a list of directories to look in, like the lists in | ||
| 638 | `exec-path' or `load-path'. | ||
| 635 | If SUFFIXES is non-nil, it should be a list of suffixes to append to | 639 | If SUFFIXES is non-nil, it should be a list of suffixes to append to |
| 636 | file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). | 640 | file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). |
| 641 | Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. | ||
| 637 | If non-nil, PREDICATE is used instead of `file-readable-p'. | 642 | If non-nil, PREDICATE is used instead of `file-readable-p'. |
| 638 | PREDICATE can also be an integer to pass to the `access' system call, | 643 | PREDICATE can also be an integer to pass to the `access' system call, |
| 639 | in which case file-name handlers are ignored. This usage is deprecated. | 644 | in which case file-name handlers are ignored. This usage is deprecated. |