From 0c69125233377bcca90fc7fca5ed5d7db7010937 Mon Sep 17 00:00:00 2001 From: Juanma Barranquero Date: Wed, 15 Oct 2008 15:32:21 +0000 Subject: [PATCH] * find-file.el (ff-get-file): Doc fix. (ff-get-file-name): Use `let', not `let*'. (ff-search-directories): Fix typo in docstring. (ff-pre-find-hook, ff-pre-load-hook, ff-post-load-hook) (ff-not-found-hook, ff-file-created-hook, ff-case-fold-search) (ff-always-in-other-window, ff-ignore-include, ff-always-try-to-create) (ff-quiet-mode, ff-other-file-alist, cc-search-directories) (cc-other-file-alist, modula2-other-file-alist): Remove spurious * in docstrings. --- lisp/ChangeLog | 12 ++++++++++ lisp/find-file.el | 56 +++++++++++++++++++++++------------------------ 2 files changed, 40 insertions(+), 28 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index e2aba3c0056..cc88b08cb5b 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,15 @@ +2008-10-15 Juanma Barranquero + + * find-file.el (ff-get-file): Doc fix. + (ff-get-file-name): Use `let', not `let*'. + (ff-search-directories): Fix typo in docstring. + (ff-pre-find-hook, ff-pre-load-hook, ff-post-load-hook) + (ff-not-found-hook, ff-file-created-hook, ff-case-fold-search) + (ff-always-in-other-window, ff-ignore-include, ff-always-try-to-create) + (ff-quiet-mode, ff-other-file-alist, cc-search-directories) + (cc-other-file-alist, modula2-other-file-alist): + Remove spurious * in docstrings. + 2008-10-14 Chong Yidong * faces.el (set-face-attribute): Set family and foundry before diff --git a/lisp/find-file.el b/lisp/find-file.el index a3b4272fe72..0ad32989090 100644 --- a/lisp/find-file.el +++ b/lisp/find-file.el @@ -130,54 +130,54 @@ :group 'find-file) (defcustom ff-pre-find-hook nil - "*List of functions to be called before the search for the file starts." + "List of functions to be called before the search for the file starts." :type 'hook :group 'ff) (defcustom ff-pre-load-hook nil - "*List of functions to be called before the other file is loaded." + "List of functions to be called before the other file is loaded." :type 'hook :group 'ff) (defcustom ff-post-load-hook nil - "*List of functions to be called after the other file is loaded." + "List of functions to be called after the other file is loaded." :type 'hook :group 'ff) (defcustom ff-not-found-hook nil - "*List of functions to be called if the other file could not be found." + "List of functions to be called if the other file could not be found." :type 'hook :group 'ff) (defcustom ff-file-created-hook nil - "*List of functions to be called if the other file needs to be created." + "List of functions to be called if the other file needs to be created." :type 'hook :group 'ff) (defcustom ff-case-fold-search nil - "*Non-nil means ignore cases in matches (see `case-fold-search'). + "Non-nil means ignore cases in matches (see `case-fold-search'). If you have extensions in different cases, you will want this to be nil." :type 'boolean :group 'ff) (defcustom ff-always-in-other-window nil - "*If non-nil, find the corresponding file in another window by default. + "If non-nil, find the corresponding file in another window by default. To override this, give an argument to `ff-find-other-file'." :type 'boolean :group 'ff) (defcustom ff-ignore-include nil - "*If non-nil, ignore `#include' lines." + "If non-nil, ignore `#include' lines." :type 'boolean :group 'ff) (defcustom ff-always-try-to-create t - "*If non-nil, always attempt to create the other file if it was not found." + "If non-nil, always attempt to create the other file if it was not found." :type 'boolean :group 'ff) (defcustom ff-quiet-mode nil - "*If non-nil, trace which directories are being searched." + "If non-nil, trace which directories are being searched." :type 'boolean :group 'ff) @@ -200,7 +200,7 @@ filename that EXTRACT returned.") (defvaralias 'ff-related-file-alist 'ff-other-file-alist) (defcustom ff-other-file-alist 'cc-other-file-alist - "*Alist of extensions to find given the current file's extension. + "Alist of extensions to find given the current file's extension. This list should contain the most used extensions before the others, since the search algorithm searches sequentially through each @@ -212,7 +212,7 @@ This alist should be set by the major mode." :group 'ff) (defcustom ff-search-directories 'cc-search-directories - "*List of directories to search for a specific file. + "List of directories to search for a specific file. Set by default to `cc-search-directories', expanded at run-time. @@ -226,7 +226,7 @@ A typical format is '(\".\" \"/usr/include\" \"$PROJECT/*/include\") Environment variables can be inserted between slashes (`/'). -They will be replaced by their definition. If a variable does +They will be replaced by their definition. If a variable does not exist, it is replaced (silently) with an empty string. The stars are *not* wildcards: they are searched for together with @@ -237,7 +237,7 @@ the preceding slash. The star represents all the subdirectories except (defcustom cc-search-directories '("." "/usr/include" "/usr/local/include/*") - "*See the description of the `ff-search-directories' variable." + "See the description of the `ff-search-directories' variable." :type '(repeat directory) :group 'ff) @@ -262,7 +262,7 @@ the preceding slash. The star represents all the subdirectories except ("\\.cxx\\'" (".hxx" ".hh" ".h")) ("\\.hxx\\'" (".cxx"))) - "*Alist of extensions to find given the current file's extension. + "Alist of extensions to find given the current file's extension. This list should contain the most used extensions before the others, since the search algorithm searches sequentially through each directory @@ -276,7 +276,7 @@ is created with the first matching extension (`.cc' yields `.hh')." ("\\.mi$" (".md")) ;; Modula-2 module definition ("\\.md$" (".mi")) ;; and implementation. ) - "*See the description for the `ff-search-directories' variable." + "See the description for the `ff-search-directories' variable." :type '(repeat (list regexp (choice (repeat string) function))) :group 'ff) @@ -611,8 +611,8 @@ the `ff-ignore-include' variable." (defun ff-get-file (search-dirs filename &optional suffix-list other-window) "Find a file in the SEARCH-DIRS with the given FILENAME (or filename stub). -If (optional) SUFFIX-LIST is nil, search for fname, otherwise search -for fname with each of the given suffixes. Get the file or the buffer +If (optional) SUFFIX-LIST is nil, search for FILENAME, otherwise search +for FILENAME with each of the given suffixes. Get the file or the buffer corresponding to the name of the first file found, or nil." (let ((filename (ff-get-file-name search-dirs filename suffix-list))) @@ -636,16 +636,16 @@ corresponding to the name of the first file found, or nil." If (optional) SUFFIX-LIST is nil, search for FNAME-STUB, otherwise search for FNAME-STUB with each of the given suffixes. Return the name of the first file found." - (let* (dirs ;; working copy of dirs to search - dir ;; the current dir considered - file ;; filename being looked for - rest ;; pathname after first /* - this-suffix ;; the suffix we are currently considering - suffixes ;; working copy of suffix-list - filename ;; built filename - blist ;; list of live buffers - buf ;; current buffer in blist - found) ;; whether we have found anything + (let (dirs ;; working copy of dirs to search + dir ;; the current dir considered + file ;; filename being looked for + rest ;; pathname after first /* + this-suffix ;; the suffix we are currently considering + suffixes ;; working copy of suffix-list + filename ;; built filename + blist ;; list of live buffers + buf ;; current buffer in blist + found) ;; whether we have found anything (setq suffixes suffix-list) -- 2.39.5