From: Eli Zaretskii <eliz@gnu.org>
Date: Tue, 11 Feb 2025 14:42:19 +0000 (+0200)
Subject: ; Document 'completing-read-multiple' in the ELisp manual
X-Git-Tag: archive/raspbian/1%30.1+1-3+rpi1^2~2^2~20^2~48
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=737f249aa2c86fb555b134b9e430a5be9cf2b655;p=emacs.git

; Document 'completing-read-multiple' in the ELisp manual

* doc/lispref/minibuf.texi (Minibuffer Completion): Mention
'completing-read-multiple' (bug#76194).
---

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 43e87f89aee..9bff31aaf3c 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -1249,6 +1249,16 @@ different function to completely override the normal behavior of
 @code{completing-read}.
 @end defvar
 
+@findex completing-read-multiple
+@vindex crm-separator
+If you need to prompt the user for several strings, like several
+elements of a list or several parameters (e.g., user, host, and port) of
+a connection, you can use @code{completing-read-multiple}.  It allows
+typing several strings separated by a separator string (by default, tabs
+and commas; customize @code{crm-separator} to change that), and provides
+completion for each individual string the user types.  It returns the
+strings that were read, as a list.
+
 @node Completion Commands
 @subsection Minibuffer Commands that Do Completion