git.cworth.org Git - notmuch-wiki/blob - nmbug.mdwn

   1 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
   2
   3 ## Getting set up
   4
   5 1. Install and use notmuch version notmuch 0.9+23~g556c5fa or newer (enter notmuch --version to check your version)
   6
   7 2. Get nmbug script using
   8
   9     git clone git://pivot.cs.unb.ca/notmuch.git notmuch-nmbug
  10     cd notmuch-nmbug
  11     git branch -b nmbug origin/nmbug
  12
  13 The script is now available in contrib/nmbug
  14
  15 3. The current tag repo can be obtained by
  16
  17     git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
  18
  19 Check that your git is recent enough by entering
  20
  21     git --git-dir=$HOME/.nmbug fetch
  22
  23 If you get failures then you need to update your git (as well).
  24
  25 ## Using nmbug, simple example
  26
  27     # get the latest version of the tags
  28     $ nmbug pull
  29
  30     # do some tagging; see below for conventions
  31
  32     $ notmuch tag +notmuch::patch $id
  33
  34     # write the tag changes from the notmuch database
  35     $ nmbug commit
  36
  37 ## Using nmbug, doing the same thing with more steps
  38
  39     # get the latest version of the tags
  40     $ nmbug fetch
  41
  42     # Optionally inspect the fetched changes
  43
  44     $ nmbug status
  45      a   tags/id1/patch
  46      d   tags/id2/pushed
  47
  48     # merge the fetched tags into notmuch
  49     $ nmbug merge
  50
  51     # observe status is clear now,
  52     $ nmbug status
  53
  54     # make the tag changes
  55     $ notmuch tag +notmuch::patch id
  56
  57     # double check your changes
  58     $ nmbug status
  59     A tags/id/patch
  60
  61     # write the tag changes
  62     $ nmbug commit
  63
  64 ## Submitting tags.
  65
  66    For the moment, we are using a central repo, hosted at
  67
  68         git@pivot.cs.unb.ca:pub/nmbug
  69
  70    To get push access, send your public key (ideally in a gpg signed
  71    email) to David Bremner.  There is a convenience command
  72
  73        nmbug push
  74
  75    But you will have to change your url with
  76
  77        git remote origin set-url git@pivot.cs.unb.ca:pub/nmbug
  78
  79 ## Tagging conventions
  80
  81     notmuch::bug                is a bug report
  82     notmuch::emacs              is a patch/bug for the emacs UI
  83     notmuch::feature            provides a new feature
  84     notmuch::fix                fixes a bug
  85     notmuch::moreinfo           waiting for feedback from patch proposer or others
  86     notmuch::obsolete           replaced by some other patch
  87     notmuch::patch
  88     notmuch::portability        improves portability
  89     notmuch::pushed             is pushed to master
  90     notmuch::review             is a review
  91     notmuch::reviewed           has been (well) reviewed
  92     notmuch::test               provides a new test/or improves testing
  93     notmuch::wip                is "work in progress", posted for review or comment.
  94
  95 ## Tracking the patch queue
  96
  97 I use the following search (in my case as a saved search in emacs).
  98
  99     tag:notmuch::patch and not tag:notmuch::pushed and \
 100         not tag:notmuch::obsolete and not tag:notmuch::wip \
 101             and not tag:notmuch::moreinfo
 102
 103 Another interesting search is
 104
 105     tag:notmuch::reviewed and not tag:notmuch::pushed
 106
 107
 108 ## Design notes
 109
 110 ### Disk format.
 111
 112 The tags are stored in a bare-repo, which means they are not obviously
 113 visible. There is an `nmbug archive` command analogous to `git
 114 archive` Tags are represented as empty files in the tree; if you extra
 115 them, the tree looks something like
 116
 117
 118     tags/878waiwi0f.wl%25james@hackervisions.org/
 119     tags/878waiwi0f.wl%25james@hackervisions.org/emacs
 120     tags/878waiwi0f.wl%25james@hackervisions.org/patch
 121     tags/87aa8j7hqu.fsf@zancas.localnet/
 122     tags/87aa8j7hqu.fsf@zancas.localnet/patch
 123     tags/87aa8j7hqu.fsf@zancas.localnet/pushed
 124
 125 The `%25` represents hex code for a character that cannot be used directly
 126 (in this case %, only because it is needed as an escape).
 127
 128 ### Assumptions
 129
 130 - Currently the parser of nmbug (like that of notmuch restore) assumes
 131   that there are no spaces in message-ids.
 132
 133
 134
 135