From: Eli Zaretskii <eliz@gnu.org>
Date: Mon, 29 Aug 2022 14:02:46 +0000 (+0300)
Subject: * lisp/find-file.el (ff-other-file-alist): Doc fix.  (Bug#57325)
X-Git-Tag: emacs-28.2~21
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4d52fe6b968b63e9c9025121147d4930ca65a05f;p=emacs.git

* lisp/find-file.el (ff-other-file-alist): Doc fix.  (Bug#57325)
---

diff --git a/lisp/find-file.el b/lisp/find-file.el
index 614ff420f25..e9aba883ae1 100644
--- a/lisp/find-file.el
+++ b/lisp/find-file.el
@@ -204,7 +204,12 @@ 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').
-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
+function must return a non-nil list of file-name extensions.  It cannot
+return nil, nor can it signal in any way a failure to find a suitable
+list of extensions."
   :type '(choice (repeat (list regexp (choice (repeat string) function)))
 		 symbol))