]> git.eshelyaron.com Git - emacs.git/commitdiff
; Yet another doc fix for 'ff-other-file-alist' (bug#57325)
authorEli Zaretskii <eliz@gnu.org>
Tue, 30 Aug 2022 12:42:34 +0000 (15:42 +0300)
committerEli Zaretskii <eliz@gnu.org>
Tue, 30 Aug 2022 12:42:34 +0000 (15:42 +0300)
lisp/find-file.el

index e9aba883ae1840acd9a8783e45b826784ef906bc..aaabec11e837135f857d20738da53a8529f463e2 100644 (file)
@@ -193,17 +193,26 @@ The value could be an alist or a symbol whose value is an alist.
 Each element of the alist has the form
 
    (REGEXP (EXTENSION...))
-or
-   (REGEXP FUNCTION)
 
 where REGEXP is the regular expression matching a file's extension,
-EXTENSIONs is the list of literal file-name extensions to search for,
-and FUNCTION is a function of one argument, the current file's name,
-that returns the list of extensions to search for.
-The list of extensions should contain the most used extensions before the
-others, since the search algorithm searches sequentially through each
-directory specified in `ff-search-directories'.  If a file is not found,
-a new one is created with the first matching extension (`.cc' yields `.hh').
+and EXTENSIONs is the list of literal file-name extensions to search
+for.  The list of extensions should contain the most used extensions
+before the others, since the search algorithm searches sequentially
+through each directory specified in `ff-search-directories'.
+
+Alist elements can also be of the form
+
+   (REGEXP FUNCTION)
+
+where FUNCTION is a function of one argument, the current file's name,
+that returns the list of possible names of the corresponding files, with
+or without leading directories.  Note the difference: FUNCTION returns
+the list of file names, not their extensions.  This is for the case when
+REGEXP is not enough to determine the file name of the other file.
+
+If a file is not found, a new one is created with the first
+matching extension or name (e.g., `.cc' yields `.hh').
+
 This alist should be set by the major mode.
 
 Note: if an element of the alist names a FUNCTION as its cdr, that