X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=nmbug.mdwn;h=32c7cbbbe831f08982f5313b10590704590cb19c;hb=1d13cef9464390ef7d740b6ff67f7f3e04fb773b;hp=6431ee9c68397c5c515bba43af5aec633687cac7;hpb=d1a8870b6e9da796c7261009d7c9a7b766608e38;p=notmuch-wiki

diff --git a/nmbug.mdwn b/nmbug.mdwn
index 6431ee9..32c7cbb 100644
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -1,3 +1,4 @@
+[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
 
 ## Web View
@@ -6,20 +7,18 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/s
 
 ## Getting started
 
-1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer and
-   perl module `Pod::Usage` (packaged as `perl-doc` in debian).
-
-   The nmbug script is available in `contrib/nmbug`.
+0. Make sure that the whole notmuch@notmuchmail.org mailing list archive is available in your email database.
 
-2. The current tag repo can be obtained by:
+1. Install and use nmbug from notmuch version **0.18** or newer and
+   perl module `Pod::Usage` (packaged as `perl-doc` in debian).
 
-   `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
+   The nmbug script is available in [devel/nmbug][nmbug].
 
-   Check that your git is recent enough by entering:
+2. Make sure your `git version` is **1.7.4** or newer. 
 
-   `$ git --git-dir=$HOME/.nmbug fetch`
+3. Enter the following command to obtain the current tag repository:
 
-   If you get failures then you need to update your git (as well).
+   `$ nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git`
 
 ## Using nmbug, simple example
 
@@ -112,6 +111,12 @@ Sometimes the process stalls, and patches get tagged:
                                 or others
     notmuch::stale              The patch no longer applies to master (or in
                                 rare cases, to release)
+
+Note that these tags typically apply to whole series of patches; it
+doesn't usually make sense to apply patches later in the series before
+earlier ones. So a patch may be tagged `moreinfo` or `stale` only
+because a predecessor patch is.
+
 ### Bug tracking tag
 
 So far we are just tagging certain messages as bug reports, meaning
@@ -158,8 +163,8 @@ example searches.
 
 The tags are stored in a bare-repo, which means they are not obviously
 visible. There is an `nmbug archive` command analogous to `git
-archive` Tags are represented as empty files in the tree; if you extra
-them, the tree looks something like:
+archive` Tags are represented as empty files in the tree; if you
+extract them, the tree looks something like:
 
     tags/878waiwi0f.wl%25james@hackervisions.org/
     tags/878waiwi0f.wl%25james@hackervisions.org/emacs
@@ -175,3 +180,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.
+
+[nmbug]: http://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug