NEWS: document possible breakage from saved-search format change

If the user has unsorted or alphabetically sorted saved-searches these
should continue to work. If they have some custom lisp sort function
then it will need updating to work with the new saved-sort
format. Document this, and how the updating should be done.

Also roll in fixes for the markdown in the first part of the NEWS
suggested by Tomi: change `just work' to *just work* and removed
periods from the end of subtitle lines.

diff --git a/NEWS b/NEWS
index 8aa418240c9229928d748915b7ce0ccdbd752bfe..f1d549996abc689a39cf235424bd8d6602af7cd3 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -15,7 +15,7 @@ Command-Line Interface
 Emacs Interface
 ---------------
 
-Changed format for saved searches.
+Changed format for saved searches
 
   The format for `notmuch-saved-searches` has changed, but old style
   saved searches are still supported. The new style means that a saved
@@ -24,7 +24,7 @@ Changed format for saved searches.
   shows.
 
   The variable is fully customizable and any configuration done
-  through customize should `just work', with the additional options
+  through customize should *just work*, with the additional options
   mentioned above. For manual customization see the documentation for
   `notmuch-saved-searches`.
 
@@ -32,7 +32,13 @@ Changed format for saved searches.
   previous versions of notmuch-emacs (even search will not work); to
   fix remove the customization for notmuch-saved-searches.
 
-Bug fix for saved searches with newlines in them.
+  If you have a custom saved search sort function (not unsorted or
+  alphabetical) then the sort function will need to be
+  modified. Replacing (car saved-search) by (notmuch-saved-search-get
+  saved-search :name) and (cdr saved-search) by
+  (notmuch-saved-search-get saved-search :query) should be sufficient.
+
+Bug fix for saved searches with newlines in them
 
   Split lines confuse `notmuch count --batch`, so we remove embedded
   newlines before calling notmuch count.