From: David Edmondson <dme@dme.org>
Date: Wed, 21 Dec 2011 19:43:39 +0000 (+0000)
Subject: Minor tidying of the nmbug description.
X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=commitdiff_plain;h=8687059c5b0c5fedd7c2160d74d9087c99d86763

Minor tidying of the nmbug description.
---

diff --git a/nmbug.mdwn b/nmbug.mdwn
index 6abefc9..12c25ca 100644
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -7,21 +7,21 @@ experimental than everything else here, and currently manually updated.
 It is generated by a
  [[python script|http://pivot.cs.unb.ca/git/?p=notmuch-scripts.git;a=blob_plain;f=scripts/nmbug-status.py]].
 
-## Getting set up
+## Getting started
 
 1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer.
 
-   The nmbug script is available in contrib/nmbug
+   The nmbug script is available in `contrib/nmbug`.
       
-2. The current tag repo can be obtained by
+2. The current tag repo can be obtained by:
 
-      git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
+   `$ git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug`
 
-    Check that your git is recent enough by entering
+   Check that your git is recent enough by entering:
 
-      git --git-dir=$HOME/.nmbug fetch
+   `$ git --git-dir=$HOME/.nmbug fetch`
 
-    If you get failures then you need to update your git (as well).
+   If you get failures then you need to update your git (as well).
 
 ## Using nmbug, simple example
 
@@ -29,7 +29,6 @@ It is generated by a
     $ nmbug pull
 
     # do some tagging; see below for conventions 
-    
     $ notmuch tag +notmuch::patch $id
     
     # write the tag changes from the notmuch database
@@ -62,53 +61,53 @@ It is generated by a
     # write the tag changes 
     $ nmbug commit
 
-## Submitting tags.
+## Submitting tags
 
-   For the moment, we are using a central repo, hosted at
+For the moment, we are using a central repo, hosted at:
     
-        git@pivot.cs.unb.ca:pub/nmbug
+    git@pivot.cs.unb.ca:pub/nmbug
         
-   To get push access, send your public key (ideally in a gpg signed
-   email) to David Bremner.  There is a convenience command
+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
+But you will have to change your url with:
    
-       git --git-dir=$HOME/.nmbug remote set-url origin git@pivot.cs.unb.ca:pub/nmbug
+    git --git-dir=$HOME/.nmbug remote set-url origin git@pivot.cs.unb.ca:pub/nmbug
 
 ## Tagging conventions
 
-Note that the tag database is probably catching up to these
-conventions.
+_Note that the tag database is probably catching up to these
+conventions._
 
 ### Main patch tracking tags
 
-Intially any patch should be tagged
+Initially any patch should be tagged:
 
-    notmuch::patch           
+    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 be tagged:
 
     notmuch::wip                is "work in progress", posted for review or comment.
 
-Most patches will be initially tagged
+Most patches will be initially tagged:
 
     notmuch::needs-review       needs some (more) review
 
-unless the are tagged
+unless the are tagged:
 
     notmuch::trivial            looks harmless
 
 Patches keep `notmuch::needs-review` until they either get enough
-reviews, or one of the following resolutions is reached
+reviews, or one of the following resolutions is reached:
     
     notmuch::obsolete           replaced by some other patch
     notmuch::pushed             is pushed to master
     notmuch::wontfix            for whatever reason, this patch will not 
                                 be applied
 
-Sometimes the process stalls, and patches get tagged
+Sometimes the process stalls, and patches get tagged:
 
     notmuch::moreinfo           waiting for feedback from patch proposer 
                                 or others