add a page describing the email corpus

[obsolete/notmuch-wiki] / nmbug.mdwn

diff --git a/nmbug.mdwn b/nmbug.mdwn
index 9f809eee1b89c48801238444eeb14cb8c9b78407..5856ded95509d6ef1523353f03f52a3c3e547c1f 100644 (file)
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -6,20 +6,16 @@ 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
+1. Install and use notmuch version **0.10** or newer and
    perl module `Pod::Usage` (packaged as `perl-doc` in debian).
 
    The nmbug script is available in `contrib/nmbug`.
 
-2. The current tag repo can be obtained by:
+2. Make sure your `git version` is **1.7.4** or newer. 
 
-   `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
-
-   Check that your git is recent enough by entering:
+3. Enter the following command to obtain the current tag repository:
 
-   `$ git --git-dir=$HOME/.nmbug fetch`
-
-   If you get failures then you need to update your git (as well).
+   `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
 
 ## Using nmbug, simple example
 
@@ -85,7 +81,8 @@ Initially any patch should be tagged:
 
     notmuch::patch
 
-Patches that are for discussion, rather than proposed for master should be tagged:
+Patches that are for discussion, rather than proposed for master
+should also be tagged:
 
     notmuch::wip                is "work in progress", posted for review or comment.
 
@@ -109,8 +106,14 @@ Sometimes the process stalls, and patches get tagged:
 
     notmuch::moreinfo           waiting for feedback from patch proposer
                                 or others
-    notmuch::stale              The patch no longer applies to master (or in 
-                                rare cases, to release)                                                        
+    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
@@ -124,6 +127,7 @@ things that "everyone" agrees should be fixed.
 
 These patches are more comments and suggestions.
 
+    notmuch::doc                is a documentation patch
     notmuch::emacs              is a patch/bug for the emacs UI
     notmuch::feature            provides a new feature
     notmuch::fix                fixes a bug
@@ -147,6 +151,9 @@ search is:
 
     tag:notmuch::reviewed and not tag:notmuch::pushed
 
+See the [[status|http://nmbug.tethera.net/status]] page for more
+example searches.
+
 ## Design notes
 
 ### Disk format