X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=nmbug.mdwn;h=6431ee9c68397c5c515bba43af5aec633687cac7;hb=eebc9595c7eaeadf2a5a23bbd4c5990c37bce2b0;hp=c5934c66457c0c74dd6733fec3c1c23f9f49680a;hpb=11971eec9f50b8bab53cb9372047cead0d6e11a2;p=notmuch-wiki diff --git a/nmbug.mdwn b/nmbug.mdwn index c5934c6..6431ee9 100644 --- a/nmbug.mdwn +++ b/nmbug.mdwn @@ -2,14 +2,15 @@ ## Web View -There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/status]]. +There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/status]]. ## Getting started -1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer. +1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer and + perl module `Pod::Usage` (packaged as `perl-doc` in debian). The nmbug script is available in `contrib/nmbug`. - + 2. The current tag repo can be obtained by: `$ git clone --bare http://nmbug.tethera.net/git/nmbug-tags.git $HOME/.nmbug` @@ -25,9 +26,9 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/s # get the latest version of the tags $ nmbug pull - # do some tagging; see below for conventions + # do some tagging; see below for conventions $ notmuch tag +notmuch::patch $id - + # write the tag changes from the notmuch database $ nmbug commit @@ -38,13 +39,13 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/s # Optionally inspect the fetched changes - $ nmbug status + $ nmbug status a tags/id1/patch - d tags/id2/pushed - + d tags/id2/pushed + # merge the fetched tags into notmuch $ nmbug merge - + # observe status is clear now, $ nmbug status @@ -54,24 +55,24 @@ There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/s # double check your changes $ nmbug status A tags/id/patch - - # write the tag changes + + # write the tag changes $ nmbug commit ## Submitting tags For the moment, we are using a central repo, hosted at: - + nmbug@nmbug.tethera.net:nmbug-tags - + To get push access, send your public key (ideally in a gpg signed email) to David Bremner. There is a convenience command: - - nmbug push - + + $ nmbug push + But you will have to change your url with: - - git --git-dir=$HOME/.nmbug remote set-url origin git@pivot.cs.unb.ca:pub/nmbug + + $ git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags ## Tagging conventions @@ -84,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. @@ -98,42 +100,46 @@ unless they are tagged: Patches keep `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 + 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 + 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) ### 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 ### 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 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 + 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 @@ -142,8 +148,10 @@ You might or might not want as many exclusions. Another interesting search is: 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 @@ -165,9 +173,5 @@ The `%25` represents hex code for a character that cannot be used directly ### Assumptions -- Currently the parser of nmbug (like that of notmuch restore) assumes +- Currently the parser of nmbug (like that of notmuch restore) assumes that there are no spaces in message-ids. - - - -