X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=nmbug.mdwn;h=63053807ad63f5e4279b6324a81acf01e7afb8e9;hb=87440cbc1d12fc3a860289b11d7b850b538dcf3d;hp=9f809eee1b89c48801238444eeb14cb8c9b78407;hpb=f245ac90f79d992cce2b789ecd12fefa91c99160;p=notmuch-wiki diff --git a/nmbug.mdwn b/nmbug.mdwn index 9f809ee..6305380 100644 --- a/nmbug.mdwn +++ b/nmbug.mdwn @@ -1,3 +1,4 @@ +[[!img notmuch-logo.png alt="Notmuch logo" class="left"]] # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch ## Web View @@ -6,20 +7,19 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/s ## Getting started -1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer and - perl module `Pod::Usage` (packaged as `perl-doc` in debian). +0. Make sure that the whole [notmuch@notmuchmail.org mailing list + archive][archive] is available in your email database. - The nmbug script is available in `contrib/nmbug`. +1. Install and use nmbug from notmuch version **0.19** or newer, and + either Python 2.7 or anything from the 3.x line. -2. The current tag repo can be obtained by: + The nmbug script is available in [devel/nmbug][nmbug]. - `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug` +2. Make sure your `git version` is **1.7.4** or newer. - Check that your git is recent enough by entering: +3. Enter the following command to obtain the current tag repository: - `$ 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 @@ -70,9 +70,9 @@ email) to David Bremner. There is a convenience command: $ nmbug push -But you will have to change your url with: +But you will have to change your push URL with: - $ git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags + $ git --git-dir=$HOME/.nmbug remote set-url --push origin nmbug@nmbug.tethera.net:nmbug-tags ## Tagging conventions @@ -85,7 +85,8 @@ Initially any patch should be tagged: 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. @@ -109,8 +110,14 @@ 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) + 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 So far we are just tagging certain messages as bug reports, meaning @@ -124,6 +131,7 @@ things that "everyone" agrees should be fixed. 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 @@ -145,7 +153,13 @@ search in emacs): You might or might not want as many exclusions. Another interesting search is: - tag:notmuch::reviewed and not tag:notmuch::pushed + 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|http://nmbug.tethera.net/status]] page for more +example searches. ## Design notes @@ -153,8 +167,8 @@ search is: 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 @@ -170,3 +184,6 @@ The `%25` represents hex code for a character that cannot be used directly - Currently the parser of nmbug (like that of notmuch restore) assumes that there are no spaces in message-ids. + +[archive]: http://notmuchmail.org/archives/notmuch.mbox +[nmbug]: http://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug