From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Fri, 28 Jan 2022 16:03:14 +0000 (+0100)
Subject: Improve the read-file-name doc string slightly
X-Git-Tag: emacs-29.0.90~2684
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=fdc72729802a60c64e44251b5a69824393ccd170;p=emacs.git

Improve the read-file-name doc string slightly

* lisp/minibuffer.el (read-file-name): Note that the semantics of
INITIAL are odd (bug#37883).
---

diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el
index 917879fb692..c9f58239403 100644
--- a/lisp/minibuffer.el
+++ b/lisp/minibuffer.el
@@ -3066,7 +3066,10 @@ Fourth arg MUSTMATCH can take the following values:
 - anything else behaves like t except that typing RET does not exit if it
   does non-null completion.
 
-Fifth arg INITIAL specifies text to start with.
+Fifth arg INITIAL specifies text to start with.  It will be
+interpreted as the trailing part of DEFAULT-FILENAME, so using a
+full file name for INITIAL will usually lead to surprising
+results.
 
 Sixth arg PREDICATE, if non-nil, should be a function of one
 argument; then a file name is considered an acceptable completion