1 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
5 There is a dump of (one view of) the nmbug [[status|nmbug/status]]. It is even more
6 experimental than everything else here, and currently manually updated.
7 It is generated by a [[python script|nmbug/report.py]].
11 1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer.
13 The nmbug script is available in contrib/nmbug
15 2. The current tag repo can be obtained by
17 git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
19 Check that your git is recent enough by entering
21 git --git-dir=$HOME/.nmbug fetch
23 If you get failures then you need to update your git (as well).
25 ## Using nmbug, simple example
27 # get the latest version of the tags
30 # do some tagging; see below for conventions
32 $ notmuch tag +notmuch::patch $id
34 # write the tag changes from the notmuch database
37 ## Using nmbug, doing the same thing with more steps
39 # get the latest version of the tags
42 # Optionally inspect the fetched changes
48 # merge the fetched tags into notmuch
51 # observe status is clear now,
54 # make the tag changes
55 $ notmuch tag +notmuch::patch id
57 # double check your changes
61 # write the tag changes
66 For the moment, we are using a central repo, hosted at
68 git@pivot.cs.unb.ca:pub/nmbug
70 To get push access, send your public key (ideally in a gpg signed
71 email) to David Bremner. There is a convenience command
75 But you will have to change your url with
77 git --git-dir=$HOME/.nmbug remote set-url origin git@pivot.cs.unb.ca:pub/nmbug
79 ## Tagging conventions
81 notmuch::bug is a bug report
82 notmuch::emacs is a patch/bug for the emacs UI
83 notmuch::feature provides a new feature
84 notmuch::fix fixes a bug
85 notmuch::moreinfo waiting for feedback from patch proposer or others
86 notmuch::obsolete replaced by some other patch
88 notmuch::portability improves portability
89 notmuch::pushed is pushed to master
90 notmuch::review is a review
91 notmuch::reviewed has been (well) reviewed
92 notmuch::test provides a new test/or improves testing
93 notmuch::wip is "work in progress", posted for review or comment.
95 ## Tracking the patch queue
97 I (David Bremner) use the following search (in my case as a saved
100 tag:notmuch::patch and not tag:notmuch::pushed and \
101 not tag:notmuch::obsolete and not tag:notmuch::wip \
102 and not tag:notmuch::moreinfo and not tag:notmuch::contrib
104 You might or might not want as many exclusions. Another interesting
107 tag:notmuch::reviewed and not tag:notmuch::pushed
114 The tags are stored in a bare-repo, which means they are not obviously
115 visible. There is an `nmbug archive` command analogous to `git
116 archive` Tags are represented as empty files in the tree; if you extra
117 them, the tree looks something like
120 tags/878waiwi0f.wl%25james@hackervisions.org/
121 tags/878waiwi0f.wl%25james@hackervisions.org/emacs
122 tags/878waiwi0f.wl%25james@hackervisions.org/patch
123 tags/87aa8j7hqu.fsf@zancas.localnet/
124 tags/87aa8j7hqu.fsf@zancas.localnet/patch
125 tags/87aa8j7hqu.fsf@zancas.localnet/pushed
127 The `%25` represents hex code for a character that cannot be used directly
128 (in this case %, only because it is needed as an escape).
132 - Currently the parser of nmbug (like that of notmuch restore) assumes
133 that there are no spaces in message-ids.