[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
emacs-28 530c3491e8: Improve documentation of bookmark default sorting
From: |
Karl Fogel |
Subject: |
emacs-28 530c3491e8: Improve documentation of bookmark default sorting |
Date: |
Thu, 17 Mar 2022 22:18:45 -0400 (EDT) |
branch: emacs-28
commit 530c3491e89bd316e628f67d5cebb7db6e7d470a
Author: Karl Fogel <kfogel@red-bean.com>
Commit: Karl Fogel <kfogel@red-bean.com>
Improve documentation of bookmark default sorting
* lisp/bookmark.el (bookmark-alist, bookmark-store,
bookmark-maybe-sort-alist): Update doc strings and comments.
---
lisp/bookmark.el | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/lisp/bookmark.el b/lisp/bookmark.el
index d568f643d9..cc9956c80a 100644
--- a/lisp/bookmark.el
+++ b/lisp/bookmark.el
@@ -249,11 +249,13 @@ functions have a binding in this keymap.")
Bookmark functions update the value automatically.
You probably do NOT want to change the value yourself.
-The value is an alist with bookmarks of the form
+The value is an alist whose elements are of the form
(BOOKMARK-NAME . PARAM-ALIST)
-or the deprecated form (BOOKMARK-NAME PARAM-ALIST).
+or the deprecated form (BOOKMARK-NAME PARAM-ALIST). The alist is
+ordered from most recently created bookmark at the front to least
+recently created bookmark at the end.
BOOKMARK-NAME is the name you gave to the bookmark when creating it.
@@ -577,10 +579,10 @@ old one."
;; Modify using the new (NAME . ALIST) format.
(setcdr bm alist))
- ;; otherwise just cons it onto the front (either the bookmark
- ;; doesn't exist already, or there is no prefix arg. In either
- ;; case, we want the new bookmark consed onto the alist...)
-
+ ;; Otherwise just put it onto the front of the list. Either the
+ ;; bookmark doesn't exist already, or there is no prefix arg.
+ ;; In either case, we want the new bookmark on the front of the
+ ;; list, since the list is kept in reverse order of creation.
(push (cons stripped-name alist) bookmark-alist))
;; Added by db
@@ -1138,7 +1140,9 @@ it to the name of the bookmark currently being set,
advancing
(defun bookmark-maybe-sort-alist ()
"Return `bookmark-alist' for display.
-If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist."
+If `bookmark-sort-flag' is non-nil, then return a sorted copy of the alist.
+Otherwise, just return `bookmark-alist', which by default is ordered
+from most recently created to least recently created bookmark."
(if bookmark-sort-flag
(sort (copy-alist bookmark-alist)
(lambda (x y) (string-lessp (car x) (car y))))
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- emacs-28 530c3491e8: Improve documentation of bookmark default sorting,
Karl Fogel <=