procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document bookmark annotations in Emacs Manual (bug#36417)

Browse source 
* doc/emacs/regs.texi (Bookmarks): Document annotations.
* lisp/bookmark.el (bookmark-use-annotations): Clarify docstring.
This commit is contained in:
Stefan Kangas 2019-06-28 13:40:37 +02:00 • committed by Eli Zaretskii
parent a1f76adfb0
commit d58fc4e8ec
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/emacs/regs.texi
View file

@ -359,6 +359,13 @@ saves bookmarks if you explicitly use @kbd{M-x bookmark-save}.
The variable @code{bookmark-default-file} specifies the file in
which to save bookmarks by default.
@vindex bookmark-use-annotations
@cindex bookmark annotations
If you set the variable @code{bookmark-use-annotations} to @code{t},
setting a bookmark will query for an annotation. If a bookmark has an
annotation, it is automatically shown in a separate window when you
jump to the bookmark.
@vindex bookmark-search-size
Bookmark position values are saved with surrounding context, so that
@code{bookmark-jump} can find the proper position even if the file is

5
lisp/bookmark.el
View file

@ -36,9 +36,6 @@
;;; Misc comments:
;;
;; If variable bookmark-use-annotations is non-nil, an annotation is
;; queried for when setting a bookmark.
;;
;; The bookmark list is sorted lexically by default, but you can turn
;; this off by setting bookmark-sort-flag to nil. If it is nil, then
;; the list will be presented in the order it is recorded
@ -52,7 +49,7 @@
(defcustom bookmark-use-annotations nil
"If non-nil, saving a bookmark queries for an annotation in a buffer."
"If non-nil, setting a bookmark queries for an annotation in a buffer."
:type 'boolean
:group 'bookmark)