summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2007-01-27 18:01:15 +0000
committerEli Zaretskii <eliz@gnu.org>2007-01-27 18:01:15 +0000
commit4fda07c1a645b7d3bae345f767212d7d215fa21e (patch)
tree38846d4955f7a4ca27a9669d1661952f428eceff /src
parent05b531f69577fc9f2bbbd3cfe7c12f1132e7fce6 (diff)
downloademacs-4fda07c1a645b7d3bae345f767212d7d215fa21e.tar.gz
(Fcompleting_read): Doc fix.
Diffstat (limited to 'src')
-rw-r--r--src/ChangeLog4
-rw-r--r--src/minibuf.c11
2 files changed, 12 insertions, 3 deletions
diff --git a/src/ChangeLog b/src/ChangeLog
index c5f022e54e0..f0d1b80ad72 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2007-01-27 Eli Zaretskii <eliz@gnu.org>
+
+ * minibuf.c (Fcompleting_read): Doc fix.
+
2007-01-26 Jan Dj,Ad(Brv <jan.h.d@swipnet.se>
* gtkutil.c (xg_initialize): Call XftInit if HAVE_XFT.
diff --git a/src/minibuf.c b/src/minibuf.c
index 5618f0223a4..9c078a37b3d 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -1686,11 +1686,16 @@ Lisp_Object Vminibuffer_completing_file_name;
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
doc: /* Read a string in the minibuffer, with completion.
PROMPT is a string to prompt with; normally it ends in a colon and a space.
-TABLE can be a list of strings, an alist, an obarray or a hash table.
-TABLE can also be a function to do the completion itself.
+
+TABLE can be a list of strings, an alist, an obarray or a hash table; their
+elements are tested to see if they begin with STRING.
+TABLE can also be a function to do the completion itself; it receives
+three arguments: the values STRING, PREDICATE and nil.
+Whatever it returns becomes the value of `try-completion'.
+
PREDICATE limits completion to a subset of TABLE.
See `try-completion' and `all-completions' for more details
- on completion, TABLE, and PREDICATE.
+ on completion, TABLE (called "alist" there), and PREDICATE.
If REQUIRE-MATCH is non-nil, the user is not allowed to exit unless
the input is (or completes to) an element of TABLE or is null.