diff options
| author | Stefan Kangas | 2019-06-28 13:40:37 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2019-06-28 21:35:21 +0300 |
| commit | d58fc4e8ece8ccafd5ef430a57c2a8b417c8e038 (patch) | |
| tree | 865161e47f475748ec033244730d1b54b98bcf2d | |
| parent | a1f76adfb03c23bb4242928e8efe6193c301f0c1 (diff) | |
| download | emacs-d58fc4e8ece8ccafd5ef430a57c2a8b417c8e038.tar.gz emacs-d58fc4e8ece8ccafd5ef430a57c2a8b417c8e038.zip | |
Document bookmark annotations in Emacs Manual (bug#36417)
* doc/emacs/regs.texi (Bookmarks): Document annotations.
* lisp/bookmark.el (bookmark-use-annotations): Clarify docstring.
| -rw-r--r-- | doc/emacs/regs.texi | 7 | ||||
| -rw-r--r-- | lisp/bookmark.el | 5 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/emacs/regs.texi b/doc/emacs/regs.texi index 37026946477..68a8245b34d 100644 --- a/doc/emacs/regs.texi +++ b/doc/emacs/regs.texi | |||
| @@ -359,6 +359,13 @@ saves bookmarks if you explicitly use @kbd{M-x bookmark-save}. | |||
| 359 | The variable @code{bookmark-default-file} specifies the file in | 359 | The variable @code{bookmark-default-file} specifies the file in |
| 360 | which to save bookmarks by default. | 360 | which to save bookmarks by default. |
| 361 | 361 | ||
| 362 | @vindex bookmark-use-annotations | ||
| 363 | @cindex bookmark annotations | ||
| 364 | If you set the variable @code{bookmark-use-annotations} to @code{t}, | ||
| 365 | setting a bookmark will query for an annotation. If a bookmark has an | ||
| 366 | annotation, it is automatically shown in a separate window when you | ||
| 367 | jump to the bookmark. | ||
| 368 | |||
| 362 | @vindex bookmark-search-size | 369 | @vindex bookmark-search-size |
| 363 | Bookmark position values are saved with surrounding context, so that | 370 | Bookmark position values are saved with surrounding context, so that |
| 364 | @code{bookmark-jump} can find the proper position even if the file is | 371 | @code{bookmark-jump} can find the proper position even if the file is |
diff --git a/lisp/bookmark.el b/lisp/bookmark.el index 9a3a2a3bdf8..bbef0a927dc 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el | |||
| @@ -36,9 +36,6 @@ | |||
| 36 | 36 | ||
| 37 | ;;; Misc comments: | 37 | ;;; Misc comments: |
| 38 | ;; | 38 | ;; |
| 39 | ;; If variable bookmark-use-annotations is non-nil, an annotation is | ||
| 40 | ;; queried for when setting a bookmark. | ||
| 41 | ;; | ||
| 42 | ;; The bookmark list is sorted lexically by default, but you can turn | 39 | ;; The bookmark list is sorted lexically by default, but you can turn |
| 43 | ;; this off by setting bookmark-sort-flag to nil. If it is nil, then | 40 | ;; this off by setting bookmark-sort-flag to nil. If it is nil, then |
| 44 | ;; the list will be presented in the order it is recorded | 41 | ;; the list will be presented in the order it is recorded |
| @@ -52,7 +49,7 @@ | |||
| 52 | 49 | ||
| 53 | 50 | ||
| 54 | (defcustom bookmark-use-annotations nil | 51 | (defcustom bookmark-use-annotations nil |
| 55 | "If non-nil, saving a bookmark queries for an annotation in a buffer." | 52 | "If non-nil, setting a bookmark queries for an annotation in a buffer." |
| 56 | :type 'boolean | 53 | :type 'boolean |
| 57 | :group 'bookmark) | 54 | :group 'bookmark) |
| 58 | 55 | ||