* subr.el (set-temporary-overlay-map): Add a docstring. (bug#12346)

Bug #12346 is not closed as this commit does not document
`set-temporary-overlay-map' in the manual.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 5864f61..cdc021d 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2012-09-11  Bastien Guerry  <bzg@gnu.org>
+
+       * subr.el (set-temporary-overlay-map): Add a docstring.
+       (bug#12346)
+
 2012-09-11  Bastien Guerry  <bzg@gnu.org>
 
        * minibuffer.el (completion-table-subvert): Fix docstring.

diff --git a/lisp/subr.el b/lisp/subr.el
index be785ff..23b62b2 100644 (file)
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -3911,6 +3911,11 @@ The properties used on SYMBOL are `composefunc', `sendfunc',
   (put symbol 'hookvar (or hookvar 'mail-send-hook)))
 \f
 (defun set-temporary-overlay-map (map &optional keep-pred)
+  "Set MAP as a temporary overlay map.
+When KEEP-PRED is `t', using a key from the temporary keymap
+leaves this keymap activated.  KEEP-PRED can also be a function,
+which will have the same effect when it returns `t'.
+When KEEP-PRED is nil, the temporary keymap is used only once."
   (let* ((clearfunsym (make-symbol "clear-temporary-overlay-map"))
          (overlaysym (make-symbol "t"))
          (alist (list (cons overlaysym map)))