1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
6 There is a dump of (some views of) the nmbug [[status|http://nmbug.tethera.net/status]].
10 0. Make sure that the whole notmuch@notmuchmail.org mailing list archive is available in your email database.
12 1. Install and use nmbug from notmuch version **0.18** or newer and
13 perl module `Pod::Usage` (packaged as `perl-doc` in debian).
15 The nmbug script is available in [devel/nmbug][nmbug].
17 2. Make sure your `git version` is **1.7.4** or newer.
19 3. Enter the following command to obtain the current tag repository:
21 `$ nmbug clone http://nmbug.tethera.net/git/nmbug-tags.git`
23 ## Using nmbug, simple example
25 # get the latest version of the tags
28 # do some tagging; see below for conventions
29 $ notmuch tag +notmuch::patch $id
31 # write the tag changes from the notmuch database
34 ## Using nmbug, doing the same thing with more steps
36 # get the latest version of the tags
39 # Optionally inspect the fetched changes
45 # merge the fetched tags into notmuch
48 # observe status is clear now,
51 # make the tag changes
52 $ notmuch tag +notmuch::patch id
54 # double check your changes
58 # write the tag changes
63 For the moment, we are using a central repo, hosted at:
65 nmbug@nmbug.tethera.net:nmbug-tags
67 To get push access, send your public key (ideally in a gpg signed
68 email) to David Bremner. There is a convenience command:
72 But you will have to change your url with:
74 $ git --git-dir=$HOME/.nmbug remote set-url origin nmbug@nmbug.tethera.net:nmbug-tags
76 ## Tagging conventions
78 _Note that the tag database is probably catching up to these
81 ### Main patch tracking tags
83 Initially any patch should be tagged:
87 Patches that are for discussion, rather than proposed for master
88 should also be tagged:
90 notmuch::wip is "work in progress", posted for review or comment.
92 Most patches will be initially tagged:
94 notmuch::needs-review needs some (more) review
96 unless they are tagged:
98 notmuch::trivial looks harmless
100 Patches keep `notmuch::needs-review` until they either get enough
101 reviews, or one of the following resolutions is reached:
103 notmuch::obsolete replaced by some other patch
104 notmuch::pushed is pushed to master
105 notmuch::wontfix for whatever reason, this patch will not
108 Sometimes the process stalls, and patches get tagged:
110 notmuch::moreinfo waiting for feedback from patch proposer
112 notmuch::stale The patch no longer applies to master (or in
113 rare cases, to release)
115 Note that these tags typically apply to whole series of patches; it
116 doesn't usually make sense to apply patches later in the series before
117 earlier ones. So a patch may be tagged `moreinfo` or `stale` only
118 because a predecessor patch is.
122 So far we are just tagging certain messages as bug reports, meaning
123 things that "everyone" agrees should be fixed.
125 notmuch::bug is a bug report
126 notmuch::fixed indicates that the bug is fixed in the
131 These patches are more comments and suggestions.
133 notmuch::doc is a documentation patch
134 notmuch::emacs is a patch/bug for the emacs UI
135 notmuch::feature provides a new feature
136 notmuch::fix fixes a bug
137 notmuch::portability improves portability
138 notmuch::review is a review
139 notmuch::test provides a new test/or improves testing
140 notmuch::$n this patch should be considered for
143 ## Tracking the patch queue
145 I (David Bremner) use the following search (in my case as a saved
148 tag:notmuch::patch and not tag:notmuch::pushed and \
149 not tag:notmuch::obsolete and not tag:notmuch::wip \
150 and not tag:notmuch::moreinfo and not tag:notmuch::contrib
152 You might or might not want as many exclusions. Another interesting
155 tag:notmuch::reviewed and not tag:notmuch::pushed
157 See the [[status|http://nmbug.tethera.net/status]] page for more
164 The tags are stored in a bare-repo, which means they are not obviously
165 visible. There is an `nmbug archive` command analogous to `git
166 archive` Tags are represented as empty files in the tree; if you
167 extract them, the tree looks something like:
169 tags/878waiwi0f.wl%25james@hackervisions.org/
170 tags/878waiwi0f.wl%25james@hackervisions.org/emacs
171 tags/878waiwi0f.wl%25james@hackervisions.org/patch
172 tags/87aa8j7hqu.fsf@zancas.localnet/
173 tags/87aa8j7hqu.fsf@zancas.localnet/patch
174 tags/87aa8j7hqu.fsf@zancas.localnet/pushed
176 The `%25` represents hex code for a character that cannot be used directly
177 (in this case %, only because it is needed as an escape).
181 - Currently the parser of nmbug (like that of notmuch restore) assumes
182 that there are no spaces in message-ids.
184 [nmbug]: http://git.notmuchmail.org/git/notmuch/blob/HEAD:/devel/nmbug/nmbug