master 12a6d319dc: Improve the bookmark-default-handler doc string

[Lars Ingebrigtsen]

branch: master
commit 12a6d319dcff5f1954f926be979b81170df2806c
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Improve the bookmark-default-handler doc string
    
    * lisp/bookmark.el (bookmark-default-handler): Document the
    `buffer' property (bug#20845).
---
 lisp/bookmark.el | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/lisp/bookmark.el b/lisp/bookmark.el
index 0279d5ea83..8753326881 100644
--- a/lisp/bookmark.el
+++ b/lisp/bookmark.el
@@ -1274,7 +1274,10 @@ then offer interactively to relocate 
BOOKMARK-NAME-OR-RECORD."
 (defun bookmark-default-handler (bmk-record)
   "Default handler to jump to a particular bookmark location.
 BMK-RECORD is a bookmark record, not a bookmark name (i.e., not a string).
-Changes current buffer and point and returns nil, or signals a `file-error'."
+Changes current buffer and point and returns nil, or signals a `file-error'.
+
+If BMK-RECORD has a property called `buffer', it should be a live
+buffer object, and this buffer will be selected."
   (let ((file          (bookmark-get-filename bmk-record))
        (buf           (bookmark-prop-get bmk-record 'buffer))
         (forward-str   (bookmark-get-front-context-string bmk-record))