Add the notmuch::wip tag and describe the saved search that I use.

[notmuch-wiki] / nmbug.mdwn

diff --git a/nmbug.mdwn b/nmbug.mdwn
index dd22a768b735993b214982a7c41147ae85ba7726..778e6f4cd6bd07463bcacacce3c93d6cea12dbf5 100644 (file)
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -9,20 +9,48 @@
     Currently you need at least the version of notmuch in master, and
     the script in contrib/nmbug.
       
-2. The current tag repo is at
+2. The current tag repo can be obtained by
 
     git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
 
+## Using nmbug, simple example
 
-## Using nmbug
+    # get the latest version of the tags
+    $ nmbug pull
 
-    # suck in the tags
-    $ nmbug checkout
-
-    [ do some tagging; see below for conventions ]
+    # do some tagging; see below for conventions 
+    
+    $ notmuch tag +notmuch::patch $id
     
+    # write the tag changes from the notmuch database
     $ nmbug commit
 
+## Using nmbug, doing the same thing with more steps
+
+    # get the latest version of the tags
+    $ nmbug fetch
+
+    # Optionally inspect the fetched changes
+
+    $ nmbug status      
+     a   tags/id1/patch
+     d   tags/id2/pushed     
+    
+    # merge the fetched tags into notmuch
+    $ nmbug merge
+    
+    # observe status is clear now,
+    $ nmbug status
+
+    # make the tag changes
+    $ notmuch tag +notmuch::patch id
+
+    # double check your changes
+    $ nmbug status
+    A tags/id/patch
+    
+    # write the tag changes 
+    $ nmbug commit
 
 ## Submitting tags.
 
@@ -52,7 +80,15 @@
     notmuch::review             is a review
     notmuch::reviewed           has been (well) reviewed
     notmuch::test               provides a new test/or improves testing
+    notmuch::wip                is "work in progress", posted for review or comment.
 
+## Tracking the patch queue
+
+    I use the following search (in my case as saved search in emacs).
+    
+    tag:notmuch::patch and not tag:notmuch::pushed and 
+        not tag:notmuch::obsolete and not tag:notmuch::wip
+        
 ## Design notes
 
 ### Disk format.
@@ -70,7 +106,7 @@ them, the tree looks something like
     tags/87aa8j7hqu.fsf@zancas.localnet/patch
     tags/87aa8j7hqu.fsf@zancas.localnet/pushed
 
-The `%25` represents hex code for a character that cannut be used directly
+The `%25` represents hex code for a character that cannot be used directly
 (in this case %, only because it is needed as an escape).
 
 ### Assumptions