[Emacs-diffs] /srv/bzr/emacs/emacs-23 r100040: Doc fixes related to diary-sort-entries.

[Glenn Morris]

------------------------------------------------------------
revno: 100040
committer: Glenn Morris <address@hidden>
branch nick: emacs-23
timestamp: Tue 2010-09-14 01:02:28 -0700
message:
  Doc fixes related to diary-sort-entries.
  
  * lisp/calendar/diary-lib.el (diary-list-entries-hook, diary-sort-entries):
  Doc fixes.
  
  * doc/emacs/cal-xtra.texi (Fancy Diary Display): Emphasize that sort
  should be the last hook item.
modified:
  doc/emacs/ChangeLog
  doc/emacs/cal-xtra.texi
  lisp/ChangeLog
  lisp/calendar/diary-lib.el

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2010-09-14 07:34:23 +0000
+++ b/doc/emacs/ChangeLog       2010-09-14 08:02:28 +0000
@@ -1,5 +1,8 @@
 2010-09-14  Glenn Morris  <address@hidden>
 
+       * cal-xtra.texi (Fancy Diary Display): Emphasize that sort should be
+       the last hook item.
+
        * calendar.texi (Appointments): Also updated when a diary include file
        is saved.
 

=== modified file 'doc/emacs/cal-xtra.texi'
--- a/doc/emacs/cal-xtra.texi   2010-01-13 08:35:10 +0000
+++ b/doc/emacs/cal-xtra.texi   2010-09-14 08:02:28 +0000
@@ -613,7 +613,9 @@
 @noindent
 For each day, this sorts diary entries that begin with a recognizable
 time of day according to their times.  Diary entries without times come
-first within each day.
+first within each day.  Note how the sort command is placed at the end
+of the hook list, in case earlier members of the list change the order
+of the diary entries, or add items.
 
 @vindex diary-include-string
   Your main diary file can include other files.  This permits a group of

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-09-14 07:21:03 +0000
+++ b/lisp/ChangeLog    2010-09-14 08:02:28 +0000
@@ -1,5 +1,8 @@
 2010-09-14  Glenn Morris  <address@hidden>
 
+       * calendar/diary-lib.el (diary-list-entries-hook, diary-sort-entries):
+       Doc fixes.
+
        * calendar/diary-lib.el (diary-included-files): New variable.
        (diary-list-entries): Maybe initialize diary-included-files.
        (diary-include-other-diary-files): Append to diary-included-files.

=== modified file 'lisp/calendar/diary-lib.el'
--- a/lisp/calendar/diary-lib.el        2010-09-14 07:15:06 +0000
+++ b/lisp/calendar/diary-lib.el        2010-09-14 08:02:28 +0000
@@ -187,11 +187,12 @@
 
      (setq diary-display-function 'diary-fancy-display)
      (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
-     (add-hook 'diary-list-entries-hook 'diary-sort-entries)
+     (add-hook 'diary-list-entries-hook 'diary-sort-entries t)
 
 in your `.emacs' file to cause the fancy diary buffer to be displayed with
 diary entries from various included files, each day's entries sorted into
-lexicographic order."
+lexicographic order.  Note how the sort function is placed last,
+so that it can sort the entries included from other files."
   :type 'hook
   :options '(diary-include-other-diary-files diary-sort-entries)
   :group 'diary)
@@ -1584,7 +1585,10 @@
                       (string-lessp ts1 ts2)))))))
 
 (defun diary-sort-entries ()
-  "Sort the list of diary entries by time of day."
+  "Sort the list of diary entries by time of day.
+If you add this function to `diary-list-entries-hook', it should
+be the last item in the hook, in case earlier items add diary
+entries, or change the order."
   (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
 
 (define-obsolete-function-alias 'sort-diary-entries 'diary-sort-entries "23.1")