summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Bremner <bremner@debian.org>2011-12-22 06:31:37 -0400
committerDavid Bremner <bremner@debian.org>2011-12-22 06:31:37 -0400
commit6d976adcf87f77b79d64914082368239a648e767 (patch)
tree62227db5dac1efabc80c812057ad209dea1fefb2
parent683d580b6b15ee2208d1eb98010810ae6716071a (diff)
parenta917025bf3f41677d1edd718e6bfa38a9c095fb3 (diff)
Merge branch 'master' of git://notmuchmail.org/git/notmuch-wiki
-rw-r--r--feature-requests.mdwn14
-rw-r--r--index.mdwn6
-rw-r--r--nmbug.mdwn60
3 files changed, 37 insertions, 43 deletions
diff --git a/feature-requests.mdwn b/feature-requests.mdwn
index 86719c4..4352ceb 100644
--- a/feature-requests.mdwn
+++ b/feature-requests.mdwn
@@ -13,7 +13,7 @@
When used from the thread view, it deletes the currently
displayed message inside the thread.
-+ add 'D' keybinding
++ Add 'D' keybinding
Removes unread and inbox tags, adds deleted tag.
@@ -23,7 +23,7 @@
When used from the thread view, it deletes the currently
displayed thread (and not just the message)
-+ add '???' keybinding
++ Add '???' keybinding
Skips current thread without archiving it
@@ -31,9 +31,7 @@
beginning of the next thread. 'a' gets you to the next thread,
but archives the current one.
-+ select from address (with the configured email addresses as default choices to pick from)
-
-+ allow different "real names" for the optional email addresses
++ Allow different "real names" for the optional email addresses
if only one name is configured, use that for all addresses;
if other_names are configured, match those with the other_email addresses
@@ -67,10 +65,10 @@
+ Allow anchors in searches
- notmuch search from:domain.org$ only matches if "domain.org" is
+ `notmuch search from:domain.org$` only matches if "domain.org" is
at the end of the From: header
- notmuch search from:^username only matches if "username" is at
+ `notmuch search from:^username` only matches if "username" is at
the beginning of the From: header (right after the ':')
This leaves the interesting question if we want a way to bind to
@@ -92,7 +90,7 @@
+ Add feature to move files in the maildir hierarchy
- notmuchsync --move "searchstring" "targetfolder"
+ `notmuchsync --move "searchstring" "targetfolder"`
Where searchstring is any valid notmuch search
diff --git a/index.mdwn b/index.mdwn
index 4381eaa..1075691 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -80,10 +80,8 @@ every commit made to notmuch and the notmuchmail.org web site.
Patches are most welcome and should be sent to notmuch&#64;notmuchmail.org.
Please try to follow the [[patch submission guidelines|patchformatting]]
-when submitting patches to notmuch. We are currently test-driving a [Patchwork
-instance](http://patchwork.notmuchmail.org/project/notmuch) to help us keep track
-of [the patches](http://patchwork.notmuchmail.org/project/notmuch/list).
-For another experiment in patch tracking, see [[nmbug]].
+when submitting patches to notmuch.
+For experiment in patch tracking, see [[nmbug]].
Source code of notmuch releases can be downloaded [here](http://notmuchmail.org/releases/).
diff --git a/nmbug.mdwn b/nmbug.mdwn
index 6abefc9..f52bcbc 100644
--- a/nmbug.mdwn
+++ b/nmbug.mdwn
@@ -7,21 +7,21 @@ experimental than everything else here, and currently manually updated.
It is generated by a
[[python script|http://pivot.cs.unb.ca/git/?p=notmuch-scripts.git;a=blob_plain;f=scripts/nmbug-status.py]].
-## Getting set up
+## Getting started
1. Install and use notmuch version notmuch 0.9+63~gebd1adc or newer.
- The nmbug script is available in contrib/nmbug
+ The nmbug script is available in `contrib/nmbug`.
-2. The current tag repo can be obtained by
+2. The current tag repo can be obtained by:
- git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug
+ `$ git clone --bare git://pivot.cs.unb.ca/nmbug.git $HOME/.nmbug`
- Check that your git is recent enough by entering
+ Check that your git is recent enough by entering:
- git --git-dir=$HOME/.nmbug fetch
+ `$ git --git-dir=$HOME/.nmbug fetch`
- If you get failures then you need to update your git (as well).
+ If you get failures then you need to update your git (as well).
## Using nmbug, simple example
@@ -29,7 +29,6 @@ It is generated by a
$ nmbug pull
# do some tagging; see below for conventions
-
$ notmuch tag +notmuch::patch $id
# write the tag changes from the notmuch database
@@ -62,53 +61,53 @@ It is generated by a
# write the tag changes
$ nmbug commit
-## Submitting tags.
+## Submitting tags
- For the moment, we are using a central repo, hosted at
+For the moment, we are using a central repo, hosted at:
- git@pivot.cs.unb.ca:pub/nmbug
+ git@pivot.cs.unb.ca:pub/nmbug
- To get push access, send your public key (ideally in a gpg signed
- email) to David Bremner. There is a convenience command
+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
+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 git@pivot.cs.unb.ca:pub/nmbug
## Tagging conventions
-Note that the tag database is probably catching up to these
-conventions.
+_Note that the tag database is probably catching up to these
+conventions._
### Main patch tracking tags
-Intially any patch should be tagged
+Initially any patch should be tagged:
- notmuch::patch
+ 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 be tagged:
notmuch::wip is "work in progress", posted for review or comment.
-Most patches will be initially tagged
+Most patches will be initially tagged:
notmuch::needs-review needs some (more) review
-unless the are tagged
+unless they are tagged:
notmuch::trivial looks harmless
Patches keep `notmuch::needs-review` until they either get enough
-reviews, or one of the following resolutions is reached
+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
be applied
-Sometimes the process stalls, and patches get tagged
+Sometimes the process stalls, and patches get tagged:
notmuch::moreinfo waiting for feedback from patch proposer
or others
@@ -133,30 +132,29 @@ These patches are more comments and suggestions.
notmuch::$n this patch should be considered for
release $n
-## TRACKING the patch queue
+## Tracking the patch queue
I (David Bremner) use the following search (in my case as a saved
-search in emacs).
+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
You might or might not want as many exclusions. Another interesting
-search is
+search is:
tag:notmuch::reviewed and not tag:notmuch::pushed
## Design notes
-### Disk format.
+### Disk format
The tags are stored in a bare-repo, which means they are not obviously
visible. There is an `nmbug archive` command analogous to `git
archive` Tags are represented as empty files in the tree; if you extra
-them, the tree looks something like
-
+them, the tree looks something like:
tags/878waiwi0f.wl%25james@hackervisions.org/
tags/878waiwi0f.wl%25james@hackervisions.org/emacs