NEWS: Document the recent 'nmbug clone' and @{upstream} changes

[notmuch] / NEWS

diff --git a/NEWS b/NEWS
index 8aa418240c9229928d748915b7ce0ccdbd752bfe..eeea10e872ec82a84c45966160cd238c9e39c172 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,11 +32,39 @@ 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.
 
+nmbug
+-----
+
+nmbug adds a `clone` command for setting up the initial repository and
+uses `@{upstream}` instead of `FETCH_HEAD` to track upstream changes.
+
+  The `@{upstream}` change reduces ambiguity when fetching multiple
+  branches, but requires existing users update their `NMBGIT`
+  repository (usually `~/.nmbug`) to distinguish between local and
+  remote-tracking branches.  The easiest way to do this is:
+
+  1. If you have any purely local commits (i.e. they aren't in the
+     nmbug repository on nmbug.tethera.net), push them to a remote
+     repository.  We'll restore them from the backup in step 4.
+  2. Remove your `NMBGIT` repository (e.g. `mv .nmbug .nmbug.bak`).
+  3. Use the new `clone` command to create a fresh clone:
+
+        nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git
+
+  4. If you had local commits in step 1, add a remote for that
+     repository and fetch them into the new repository.
+
 Notmuch 0.17 (2013-12-30)
 =========================