Mercurial > emacs

changeset 105444:51af2a71a0d6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(bookmark-alist): Document the new `handler' element in the param alist. (bookmark-make-record-function): Adjust documentation for above. (Bug#4193)
author Karl Fogel <kfogel@red-bean.com>
date Sun, 04 Oct 2009 23:48:33 +0000
parents 96a9f1a0939b
children 01d333402a8c
files lisp/ChangeLog lisp/bookmark.el
diffstat 2 files changed, 16 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Sun Oct 04 23:31:52 2009 +0000
+++ b/lisp/ChangeLog	Sun Oct 04 23:48:33 2009 +0000
@@ -1,3 +1,10 @@
+2009-10-04  Karl Fogel  <kfogel@red-bean.com>
+
+	* bookmark.el (bookmark-alist): Document the new `handler' element
+	in the param alist.
+	(bookmark-make-record-function): Adjust documentation for above.
+	(Bug#4193)
+
 2009-10-04  Karl Fogel  <kfogel@red-bean.com>
 
 	* info.el (Info-bookmark-make-record): Document this function.
--- a/lisp/bookmark.el	Sun Oct 04 23:31:52 2009 +0000
+++ b/lisp/bookmark.el	Sun Oct 04 23:48:33 2009 +0000
@@ -270,7 +270,12 @@
   (front-context-string . FRONT-STR)
   (rear-context-string  . REAR-STR)
   (position . POS)
-  (annotation . ANNOTATION)))")
+  (handler . HANDLER-FUNC)
+  (annotation . ANNOTATION))
+
+If the element `(handler . HANDLER-FUNC)' is present, HANDLER-FUNC
+will be used to open this bookmark instead of `bookmark-default-handler',
+whose calling discipline HANDLER-FUNC should of course match.")
 
 
 (defvar bookmarks-already-loaded nil)
@@ -457,10 +462,9 @@
 
 The returned record should be a cons cell of the form (NAME . ALIST)
 where ALIST is as described in `bookmark-alist' and may typically contain
-a special cons (handler . SOME-FUNCTION) which sets the handler function
-that should be used to open this bookmark instead of
-`bookmark-default-handler'.  The handler should follow the same calling
-convention as the one used by `bookmark-default-handler'.
+a special cons (handler . HANDLER-FUNC) which specifies the handler function
+that should be used instead of `bookmark-default-handler' to open this
+bookmark.  See the documentation for `bookmark-alist' for more.
 
 NAME is a suggested name for the constructed bookmark.  It can be nil
 in which case a default heuristic will be used.  The function can also