diff options
| author | Stefan Kangas | 2019-07-02 07:09:13 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2019-07-06 11:54:55 +0300 |
| commit | 43d2a0a4a8092d675bc9c5412f0bf71f78b1f97f (patch) | |
| tree | 1482c85cb8dbc95b4d7a34a9988cd4bd274681f6 | |
| parent | 4436bd30aed4b1a0c64f94321e48bb1c174ccc4b (diff) | |
| download | emacs-43d2a0a4a8092d675bc9c5412f0bf71f78b1f97f.tar.gz emacs-43d2a0a4a8092d675bc9c5412f0bf71f78b1f97f.zip | |
* lisp/bookmark.el (bookmark-set-internal): Doc fix. (Bug#25032)
| -rw-r--r-- | lisp/bookmark.el | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/lisp/bookmark.el b/lisp/bookmark.el index d4a54895aa0..4f908313ccf 100644 --- a/lisp/bookmark.el +++ b/lisp/bookmark.el | |||
| @@ -746,18 +746,23 @@ CODING is the symbol of the coding-system in which the file is encoded." | |||
| 746 | map)) | 746 | map)) |
| 747 | 747 | ||
| 748 | (defun bookmark-set-internal (prompt name overwrite-or-push) | 748 | (defun bookmark-set-internal (prompt name overwrite-or-push) |
| 749 | "Interactively set a bookmark named NAME at the current location. | 749 | "Set a bookmark using specified NAME or prompting with PROMPT. |
| 750 | 750 | The bookmark is set at the current location. | |
| 751 | Begin the interactive prompt with PROMPT, followed by a space, a | 751 | |
| 752 | generated default name in parentheses, a colon and a space. | 752 | If NAME is non-nil, use it as the name of the new bookmark. In |
| 753 | 753 | this case, the value of PROMPT is ignored. | |
| 754 | If OVERWRITE-OR-PUSH is nil, then error if there is already a | 754 | |
| 755 | bookmark named NAME; if `overwrite', then replace any existing | 755 | Otherwise, prompt the user for the bookmark name. Begin the |
| 756 | bookmark if there is one; if `push' then push the new bookmark | 756 | interactive prompt with PROMPT, followed by a space, a generated |
| 757 | onto the bookmark alist. The `push' behavior means that among | 757 | default name in parentheses, a colon and a space. |
| 758 | bookmarks named NAME, this most recently set one becomes the one in | 758 | |
| 759 | effect, but the others are still there, in order, if the topmost one | 759 | OVERWRITE-OR-PUSH controls what happens if there is already a |
| 760 | is ever deleted." | 760 | bookmark with the same name: nil means signal an error; |
| 761 | `overwrite' means replace any existing bookmark; `push' means | ||
| 762 | push the new bookmark onto the bookmark alist. The `push' | ||
| 763 | behavior means that among bookmarks with the same name, this most | ||
| 764 | recently set one becomes the one in effect, but the others are | ||
| 765 | still there, in order, if the topmost one is ever deleted." | ||
| 761 | (unwind-protect | 766 | (unwind-protect |
| 762 | (let* ((record (bookmark-make-record)) | 767 | (let* ((record (bookmark-make-record)) |
| 763 | ;; `defaults' is a transient element of the | 768 | ;; `defaults' is a transient element of the |