1 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
5 1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer.
7 The nmbug script is available in contrib/nmbug
9 2. The current tag repo can be obtained by
11 git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
13 Check that your git is recent enough by entering
15 git --git-dir=$HOME/.nmbug fetch
17 If you get failures then you need to update your git (as well).
19 ## Using nmbug, simple example
21 # get the latest version of the tags
24 # do some tagging; see below for conventions
26 $ notmuch tag +notmuch::patch $id
28 # write the tag changes from the notmuch database
31 ## Using nmbug, doing the same thing with more steps
33 # get the latest version of the tags
36 # Optionally inspect the fetched changes
42 # merge the fetched tags into notmuch
45 # observe status is clear now,
48 # make the tag changes
49 $ notmuch tag +notmuch::patch id
51 # double check your changes
55 # write the tag changes
60 For the moment, we are using a central repo, hosted at
62 git@pivot.cs.unb.ca:pub/nmbug
64 To get push access, send your public key (ideally in a gpg signed
65 email) to David Bremner. There is a convenience command
69 But you will have to change your url with
71 git remote origin set-url git@pivot.cs.unb.ca:pub/nmbug
73 ## Tagging conventions
75 notmuch::bug is a bug report
76 notmuch::emacs is a patch/bug for the emacs UI
77 notmuch::feature provides a new feature
78 notmuch::fix fixes a bug
79 notmuch::moreinfo waiting for feedback from patch proposer or others
80 notmuch::obsolete replaced by some other patch
82 notmuch::portability improves portability
83 notmuch::pushed is pushed to master
84 notmuch::review is a review
85 notmuch::reviewed has been (well) reviewed
86 notmuch::test provides a new test/or improves testing
87 notmuch::wip is "work in progress", posted for review or comment.
89 ## Tracking the patch queue
91 I use the following search (in my case as a saved search in emacs).
93 tag:notmuch::patch and not tag:notmuch::pushed and \
94 not tag:notmuch::obsolete and not tag:notmuch::wip \
95 and not tag:notmuch::moreinfo
97 Another interesting search is
99 tag:notmuch::reviewed and not tag:notmuch::pushed
106 The tags are stored in a bare-repo, which means they are not obviously
107 visible. There is an `nmbug archive` command analogous to `git
108 archive` Tags are represented as empty files in the tree; if you extra
109 them, the tree looks something like
112 tags/878waiwi0f.wl%25james@hackervisions.org/
113 tags/878waiwi0f.wl%25james@hackervisions.org/emacs
114 tags/878waiwi0f.wl%25james@hackervisions.org/patch
115 tags/87aa8j7hqu.fsf@zancas.localnet/
116 tags/87aa8j7hqu.fsf@zancas.localnet/patch
117 tags/87aa8j7hqu.fsf@zancas.localnet/pushed
119 The `%25` represents hex code for a character that cannot be used directly
120 (in this case %, only because it is needed as an escape).
124 - Currently the parser of nmbug (like that of notmuch restore) assumes
125 that there are no spaces in message-ids.