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

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

[W. Trevor King]

The changes 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/
---
Changes since v1 [1]:

* Use HTTP (instead of the Git protocol) for the remote URL [2].
* Remove “bare” from the text motivating a fresh clone.
  Replace it with a reference to remote-tracking branches [2,3].
* Elaborate on the local-commit-backup step (step 1) [4].

[1]: id:151b4a1b9612daa53fb47b60f0aa65f7a8e5ef5e.1396972599.git.wking@tremily.us
     http://thread.gmane.org/gmane.mail.notmuch.general/17457/focus=17812
[2]: id:20140409210108.GB21805@odin.tremily.us
     http://article.gmane.org/gmane.mail.notmuch.general/17817
[3]: id:87bnw2wcwq.fsf@zancas.localnet
     http://article.gmane.org/gmane.mail.notmuch.general/17885
[4]: id:20140410020559.GC21805@odin.tremily.us
     http://article.gmane.org/gmane.mail.notmuch.general/17819

 NEWS | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/NEWS b/NEWS
index d4f4ea4..630607f 100644
--- a/NEWS
+++ b/NEWS
@@ -20,6 +20,28 @@ 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)
 =========================
 
-- 
1.9.1.353.gc66d89d

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

[Tomi Ollila]

On Wed, Apr 16 2014, "W. Trevor King" <wking@tremily.us> wrote:

> The changes 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/
> ---

LGTM (source $ news2wiki.pl-generated mdwn).

> Changes since v1 [1]:
>
> * Use HTTP (instead of the Git protocol) for the remote URL [2].
> * Remove “bare” from the text motivating a fresh clone.
>   Replace it with a reference to remote-tracking branches [2,3].
> * Elaborate on the local-commit-backup step (step 1) [4].
>
> [1]: id:151b4a1b9612daa53fb47b60f0aa65f7a8e5ef5e.1396972599.git.wking@tremily.us
>      http://thread.gmane.org/gmane.mail.notmuch.general/17457/focus=17812
> [2]: id:20140409210108.GB21805@odin.tremily.us
>      http://article.gmane.org/gmane.mail.notmuch.general/17817
> [3]: id:87bnw2wcwq.fsf@zancas.localnet
>      http://article.gmane.org/gmane.mail.notmuch.general/17885
> [4]: id:20140410020559.GC21805@odin.tremily.us
>      http://article.gmane.org/gmane.mail.notmuch.general/17819
>
>  NEWS | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
>
> diff --git a/NEWS b/NEWS
> index d4f4ea4..630607f 100644
> --- a/NEWS
> +++ b/NEWS
> @@ -20,6 +20,28 @@ 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)
>  =========================
>  
> -- 
> 1.9.1.353.gc66d89d
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

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

[David Bremner]

"W. Trevor King" <wking@tremily.us> writes:

> The changes 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].

pushed.