X-Git-Url: https://git.cworth.org/git?p=obsolete%2Fnotmuch-wiki;a=blobdiff_plain;f=nmbug.mdwn;h=8f712d6d00d62d2908a90a2ad1606178cf7f649d;hp=6bc04c863882a74bf56f9aa3d358507d9f6a8f19;hb=882d2cdc07b55af79c5354fb2562daee22a62b81;hpb=e5c004916ff69ea08403dffe5ee50f5cafe1b0e8

diff --git a/nmbug.mdwn b/nmbug.mdwn
index 6bc04c8..8f712d6 100644
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -6,19 +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.
+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:
-
-   `$ 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).
+   `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
 
 ## Using nmbug, simple example
 
@@ -67,11 +64,11 @@ For the moment, we are using a central repo, hosted at:
 To get push access, send your public key (ideally in a gpg signed
 email) to David Bremner.  There is a convenience command:
 
-    nmbug push
+    $ nmbug push
 
 But you will have to change your url with:
 
-    git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags
+    $ git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags
 
 ## Tagging conventions
 
@@ -84,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.
 
@@ -108,6 +106,13 @@ 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)
+
+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
 
@@ -115,11 +120,14 @@ So far we are just tagging certain messages as bug reports, meaning
 things that "everyone" agrees should be fixed.
 
     notmuch::bug                is a bug report
+    notmuch::fixed              indicates that the bug is fixed in the
+                                master branch
 
 ### Optional tags
 
 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
@@ -143,14 +151,17 @@ 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
 
 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