+[[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
# Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
## Web View
## Getting started
-1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer and
+1. Install and use nmbug from notmuch version **0.18** or newer and
perl module `Pod::Usage` (packaged as `perl-doc` in debian).
- The nmbug script is available in `contrib/nmbug`.
+ The nmbug script is available in [devel/nmbug][nmbug].
-2. The current tag repo can be obtained by:
+2. Make sure your `git version` is **1.7.4** or newer.
- `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug`
+3. Enter the following command to obtain the current tag repository:
- 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).
+ `$ nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git`
## Using nmbug, simple example
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 also be tagged:
notmuch::wip is "work in progress", posted for review or comment.
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 `moreinfo` or `stale` only
+because a predecessor patch is.
### Bug tracking tag
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
### Optional tags
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
tag:notmuch::reviewed and not tag:notmuch::pushed
+See the [[status|http://nmbug.tethera.net/status]] page for more
+example searches.
+
## 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:
+archive` Tags are represented as empty files in the tree; if you
+extract them, the tree looks something like:
tags/878waiwi0f.wl%25james@hackervisions.org/
tags/878waiwi0f.wl%25james@hackervisions.org/emacs
- Currently the parser of nmbug (like that of notmuch restore) assumes
that there are no spaces in message-ids.
+
+[nmbug]: http://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug