# Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch ## Getting set up 1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer. The nmbug script is available in contrib/nmbug 2. The current tag repo can be obtained by git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug Check that your git is recent enough by entering git --git-dir=$HOME/.nmbug fetch If you get failures then you need to update your git (as well). ## Using nmbug, simple example # get the latest version of the tags $ nmbug pull # 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. For the moment, we are using a central repo, hosted at 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 nmbug push But you will have to change your url with git remote origin set-url git@pivot.cs.unb.ca:pub/nmbug ## Tagging conventions notmuch::bug is a bug report notmuch::emacs is a patch/bug for the emacs UI notmuch::feature provides a new feature notmuch::fix fixes a bug notmuch::moreinfo waiting for feedback from patch proposer or others notmuch::obsolete replaced by some other patch notmuch::patch notmuch::portability improves portability notmuch::pushed is pushed to master 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 (David Bremner) use the following search (in my case as a saved search in emacs). tag:notmuch::patch and not tag:notmuch::pushed and \ not tag:notmuch::obsolete and not tag:notmuch::wip \ and not tag:notmuch::moreinfo and not tag:notmuch::contrib You might or might not want as many exclusions. Another interesting search is tag:notmuch::reviewed and not tag:notmuch::pushed ## 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 tags/878waiwi0f.wl%25james@hackervisions.org/ tags/878waiwi0f.wl%25james@hackervisions.org/emacs tags/878waiwi0f.wl%25james@hackervisions.org/patch tags/87aa8j7hqu.fsf@zancas.localnet/ tags/87aa8j7hqu.fsf@zancas.localnet/patch tags/87aa8j7hqu.fsf@zancas.localnet/pushed 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 - Currently the parser of nmbug (like that of notmuch restore) assumes that there are no spaces in message-ids.