nmbug: Document early 'nmbug checkout'

[notmuch-wiki] / nmbug.mdwn

diff --git a/nmbug.mdwn b/nmbug.mdwn
index c3a6789d799724b756850020596d8529c42326a1..e962c06bfa2f7ef7ed91cf13c13ae9d1e3b0d968 100644 (file)
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -10,6 +10,12 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.notmuchmail.o
 0. Make sure that the whole [notmuch@notmuchmail.org mailing list
    archive][archive] is available in your email database.
 
+   If you are missing messages which are tagged in the nmbug
+   repository, `nmbug status` will complain with U-prefixed lines and
+   you will have to jump through some hoops to create commits that
+   alter tags for those messages.  Most other nmbug operation will be
+   unaffected.
+
 1. Install and use nmbug from notmuch version **0.19** or newer, and
    either Python 2.7 or anything from the 3.x line.
 
@@ -21,6 +27,13 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.notmuchmail.o
 
    `$ nmbug clone http://nmbug.notmuchmail.org/git/nmbug-tags.git`
 
+4. Clobber your local `notmuch::…` tag namespace with:
+
+   `$ nmbug checkout`
+
+   Without this, `nmbug status` will list all of the upstream tags as
+   deleted (with the D prefix).
+
 ## Using nmbug, simple example
 
     # get the latest version of the tags
@@ -185,5 +198,5 @@ The `%25` represents hex code for a character that cannot be used directly
 - Currently the parser of nmbug (like that of notmuch restore) assumes
   that there are no spaces in message-ids.
 
-[archive]: http://notmuchmail.org/archives/notmuch.mbox
-[nmbug]: http://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug
+[archive]: https://notmuchmail.org/archives/notmuch.mbox
+[nmbug]: https://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug