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

Subject: [PATCH] NEWS: Document the recent 'nmbug clone' and @{upstream} changes

Date: Tue, 8 Apr 2014 08:57:38 -0700

To: notmuch

Cc:

From: W. Trevor King

The changes just landed with c200167 (nmbug: Add 'clone' and replace
FETCH_HEAD with @{upstream}, 2014-03-09).

The preferred markup language for NEWS seems to be Markdown, which is
parsed by devel/news2wiki.pl into Markdown chunks for rendering by
ikiwiki [1].

[1]: http://notmuchmail.org/news/
---
 NEWS | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/NEWS b/NEWS
index d4f4ea4..e26fa0a 100644
--- a/NEWS
+++ b/NEWS
@@ -20,6 +20,26 @@ 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 bare `NMBGIT`
+  repository (usually `~/.nmbug`) to a non-bare repository.  The
+  easiest way to do this is:
+
+  1. Push any local commits to a remote repository.
+  2. Remove your `NMBGIT` repository (e.g. `mv .nmbug .nmbug.bak`).
+  3. Use the new `clone` command to create a fresh clone:
+
+        nmbug clone nmbug@nmbug.tethera.net:nmbug-tags
+
+  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)
 =========================
 
-- 
1.9.1.353.gc66d89d

Thread: