1 # Experimental Tag Sharing / Pseudo-Bug-Tracking for/with notmuch
5 1. The current set of patches against notmuch master is in branch nmbug,
7 git://pivot.cs.unb.ca/notmuch.git
9 Currently you need at least the version of notmuch in master, and
10 the script in contrib/nmbug.
12 2. The current tag repo can be obtained by
14 git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
16 ## Using nmbug, simple example
18 # get the latest version of the tags
21 # do some tagging; see below for conventions
23 $ notmuch tag +notmuch::patch $id
25 # write the tag changes from the notmuch database
28 ## Using nmbug, doing the same thing with more steps
30 # get the latest version of the tags
33 # Optionally inspect the fetched changes
39 # merge the fetched tags into notmuch
42 # observe status is clear now,
45 # make the tag changes
46 $ notmuch tag +notmuch::patch id
48 # double check your changes
52 # write the tag changes
57 For the moment, we are using a central repo, hosted at
59 git@pivot.cs.unb.ca:pub/nmbug
61 To get push access, send your public key (ideally in a gpg signed
62 email) to David Bremner. There is a convenience command
66 But you will have to change your url with
68 git remote origin set-url git@pivot.cs.unb.ca:pub/nmbug
70 ## Tagging conventions
72 notmuch::bug is a bug report
73 notmuch::emacs is a patch/bug for the emacs UI
74 notmuch::feature provides a new feature
75 notmuch::fix fixes a bug
76 notmuch::obsolete replaced by some other patch
78 notmuch::portability improves portability
79 notmuch::pushed is pushed to master
80 notmuch::review is a review
81 notmuch::reviewed has been (well) reviewed
82 notmuch::test provides a new test/or improves testing
83 notmuch::wip is "work in progress", posted for review or comment.
85 ## Tracking the patch queue
87 I use the following search (in my case as a saved search in emacs).
89 tag:notmuch::patch and not tag:notmuch::pushed and
90 not tag:notmuch::obsolete and not tag:notmuch::wip
96 The tags are stored in a bare-repo, which means they are not obviously
97 visible. There is an `nmbug archive` command analogous to `git
98 archive` Tags are represented as empty files in the tree; if you extra
99 them, the tree looks something like
102 tags/878waiwi0f.wl%25james@hackervisions.org/
103 tags/878waiwi0f.wl%25james@hackervisions.org/emacs
104 tags/878waiwi0f.wl%25james@hackervisions.org/patch
105 tags/87aa8j7hqu.fsf@zancas.localnet/
106 tags/87aa8j7hqu.fsf@zancas.localnet/patch
107 tags/87aa8j7hqu.fsf@zancas.localnet/pushed
109 The `%25` represents hex code for a character that cannot be used directly
110 (in this case %, only because it is needed as an escape).
114 - Currently the parser of nmbug (like that of notmuch restore) assumes
115 that there are no spaces in message-ids.