Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
There is a dump of (some views of) the nmbug status.
Make sure that the whole email@example.com mailing list archive is available in your email database.
Install and use nmbug from notmuch version 0.19 or newer, and either Python 2.7 or anything from the 3.x line.
The nmbug script is available in devel/nmbug.
Make sure your
git versionis 1.7.4 or newer.
Enter the following command to obtain the current tag repository:
$ nmbug clone http://nmbug.notmuchmail.org/git/nmbug-tags.git
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
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
But you will have to change your push URL with:
$ git --git-dir=$HOME/.nmbug remote set-url --push origin firstname.lastname@example.org:nmbug-tags
Note that the tag database is probably catching up to these conventions.
Main patch tracking tags
Initially any patch 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.
Most patches will be initially tagged:
notmuch::needs-review needs some (more) review
unless they are tagged:
notmuch::trivial looks harmless
notmuch::needs-review until they either get enough
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:
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
because a predecessor patch is.
Bug tracking tag
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
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 notmuch::portability improves portability notmuch::review is a review notmuch::test provides a new test/or improves testing notmuch::$n this patch should be considered for release $n
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::patch and not tag:notmuch::needs-review and not \ tag:notmuch::pushed and not tag:notmuch::obsolete and not \ tag:notmuch::wontfix and not tag:notmuch::moreinfo and not \ tag:notmuch::stale and not tag:notmuch::wip
See the status page for more example searches.
The tags are stored in a bare-repo, which means they are not obviously
visible. There is an
nmbug archive command analogous to
archive Tags are represented as empty files in the tree; if you
extract them, the tree looks something like:
email@example.com/ firstname.lastname@example.org/emacs email@example.com/patch firstname.lastname@example.org/ email@example.com/patch firstname.lastname@example.org/pushed
%25 represents hex code for a character that cannot be used directly
(in this case %, only because it is needed as an escape).
- Currently the parser of nmbug (like that of notmuch restore) assumes that there are no spaces in message-ids.