From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 7 May 2005 11:15:53 +0000 (+0000)
Subject: Document locate-file.
X-Git-Tag: ttn-vms-21-2-B4~466
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f3c2dbe9146caafcf968904434c70c04669ac509;p=emacs.git

Document locate-file.
Move description of new command-line options to where they belong.
---

diff --git a/etc/NEWS b/etc/NEWS
index 5b7338c5c3d..391c99c53f8 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -120,6 +120,23 @@ the blinking cursor.
 ** New command line option -nbc or --no-blinking-cursor disables
 the blinking cursor on graphical terminals.
 
++++
+** The option --script FILE runs Emacs in batch mode and loads FILE.
+It is useful for writing Emacs Lisp shell script files, because they
+can start with this line:
+
+   #!/usr/bin/emacs --script
+
++++
+** The option --directory DIR now modifies `load-path' immediately.
+Directories are added to the front of `load-path' in the order they
+appear on the command line.  For example, with this command line:
+
+  emacs -batch -L .. -L /tmp --eval "(require 'foo)"
+
+Emacs looks for library `foo' in the parent directory, then in /tmp, then
+in the other directories in `load-path'.  (-L is short for --directory.)
+
 +++
 ** The command line option --no-windows has been changed to
 --no-window-system.  The old one still works, but is deprecated.
@@ -2842,22 +2859,17 @@ the command `undefined'.  (In earlier Emacs versions, it used
 
 * Lisp Changes in Emacs 22.1
 
-+++
-** The option --script FILE runs Emacs in batch mode and loads FILE.
-It is useful for writing Emacs Lisp shell script files, because they
-can start with this line:
-
-   #!/usr/bin/emacs --script
-
-+++
-** The option --directory DIR now modifies `load-path' immediately.
-Directories are added to the front of `load-path' in the order they
-appear on the command line.  For example, with this command line:
-
-  emacs -batch -L .. -L /tmp --eval "(require 'foo)"
-
-Emacs looks for library `foo' in the parent directory, then in /tmp, then
-in the other directories in `load-path'.  (-L is short for --directory.)
+** New function `locate-file' searches for a file in a list of directories.
+`locate-file' accepts a name of a file to search (a string), and two
+lists: a list of directories to search in and a list of suffixes to
+try; typical usage might use `exec-path' and `load-path' for the list
+of directories, and `exec-suffixes' and `load-suffixes' for the list
+of suffixes.  The function also accepts a predicate argument to
+further filter candidate files.
+
+One advantage of using this function is that the list of suffixes in
+`exec-suffixes' is OS-dependant, so this function will find
+executables without polluting Lisp code with OS dependancies.
 
 +++
 ** The default value of `sentence-end' is now defined using the new