; Yet another doc fix for 'ff-other-file-alist' (bug#57325)

This commit is contained in:
Eli Zaretskii 2022-08-30 15:42:34 +03:00
parent 2d9a391727
commit 0cbcaf5119

View 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 Each element of the alist has the form
(REGEXP (EXTENSION...)) (REGEXP (EXTENSION...))
or
(REGEXP FUNCTION)
where REGEXP is the regular expression matching a file's extension, where REGEXP is the regular expression matching a file's extension,
EXTENSIONs is the list of literal file-name extensions to search for, and EXTENSIONs is the list of literal file-name extensions to search
and FUNCTION is a function of one argument, the current file's name, for. The list of extensions should contain the most used extensions
that returns the list of extensions to search for. before the others, since the search algorithm searches sequentially
The list of extensions should contain the most used extensions before the through each directory specified in `ff-search-directories'.
others, since the search algorithm searches sequentially through each
directory specified in `ff-search-directories'. If a file is not found, Alist elements can also be of the form
a new one is created with the first matching extension (`.cc' yields `.hh').
(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. This alist should be set by the major mode.
Note: if an element of the alist names a FUNCTION as its cdr, that Note: if an element of the alist names a FUNCTION as its cdr, that