[Emacs-diffs] /srv/bzr/emacs/trunk r109983: * subr.el (set-temporary-overlay-map): Add a docstring. (bug#12346)

[Bastien Guerry]

------------------------------------------------------------
revno: 109983
committer: Bastien Guerry <address@hidden>
branch nick: trunk
timestamp: Tue 2012-09-11 18:45:31 +0200
message:
  * 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.
modified:
  lisp/ChangeLog
  lisp/subr.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-09-11 14:06:33 +0000
+++ b/lisp/ChangeLog    2012-09-11 16:45:31 +0000
@@ -1,5 +1,10 @@
 2012-09-11  Bastien Guerry  <address@hidden>
 
+       * subr.el (set-temporary-overlay-map): Add a docstring.
+       (bug#12346)
+
+2012-09-11  Bastien Guerry  <address@hidden>
+
        * minibuffer.el (completion-table-subvert): Fix docstring.
        (bug#12347)
 

=== modified file 'lisp/subr.el'
--- a/lisp/subr.el      2012-09-09 06:43:47 +0000
+++ b/lisp/subr.el      2012-09-11 16:45:31 +0000
@@ -3911,6 +3911,11 @@
   (put symbol 'hookvar (or hookvar 'mail-send-hook)))
 
 (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)))