notmuch config: Provide support for querying non-standard configuration values.

We might as well be general here, and allow the "notmuch config" command
to query any stored value from the configuration file, (whether or not
the rest of the code actually knows anything about that value).

notmuch: Add a new "notmuch config" command for querying configuration.

So far, we implement only "notmuch config get". It won't be too much
work from here to also implement "notmuch config set".

TODO: Note idea for a new "notmuch compose"

Which would also allow the recently added test of sending an email
message with the emacs interface to be a little more honest about the
From address.

test: Add test that emacs interface actually sends mail.

Rather than *reall* sending mail here, we instead have a new test
program, smtp-dummy which implements (a small piece of) the
server-side SMTP protocol and saves a mail message to the filename
provided. This gives us reasonable test coverage of a large chunk of
the notmuch+emacs code base (down to talking to an SMTP server with
the final mail contents).

test: Set alternate HOME during tests.

We set the HOME environment variable to the test directory to avoid
the tests relying on any configuration files from the test author's
own home directory, (such as ${HOME}/.emacs or similar).

test: Fix false failure from the "available tests" test.

We recently added a new sub-directory below test, so we have to
blacklist it explicitly in this test.

notmuch search: Fix to handle failure of notmuch_query_search_threads.

Now that notmuch_query_search_threads can return NULL, (for example,
due to a Xapian exception), we need to handle that case (rather than
just segfault). It's simple enough to just return a non-zero exit
code.

lib: Fix notmuch_query_search_threads to return NULL on any Xapian exception.

Previously, if the underlying search_messages hit an exception and returned
NULL, this function would ignore that and return a non-NULL, (but empty)
threads object. Fix this to properly propagate the error.

emacs: Fix quoting of Message-Id to fix test case of Id containing ".."

If Xapian sees unquoted ".." as in id:123..456 then it thinks that's a
range specification. We avoid this problem by instead passing
id:"123..456" to Xapian.

test: Add test demonstrating failure in emacs interface when Message-Id has ..

Thanks to Jameson Rollins for pointing out this bug
(id:87y6g7zr6q.fsf@servo.finestructure.net).

test: Add tests for adding/removing tags within emacs interface

Exercising both the notmuch-search and notmuch-show views.

test: Add simple tests for navigating notmuch-hello and notmuch-search views

We simulate the act of selecting the "inbox" saved search from
notmuch-hello and the act of selecting a desired thread from the
notmuch-search results.

The test for the navigation of notmuch-hello is currently marked as
BROKEN since its output is in the opposite order compared to the
'(notmuch-search "tag:inbox")' test. This question of ordering is a
currently open issue on the notmuch mailing list, so we'll let the
test suite reflect that for now.

Finally, this commit also abstracts some common emacs lisp code,
(waiting for the current buffer's process to complete), into a new
notmuch-test-wait function that is made available to anything calling
test_emacs.

test: Add a new test_expect_equal_failure

Which allows us to have a known-broken test that would otherwise use
test_expect_equal.

test: Add tests for emacs notmuch-search and notmuch-show functions.

Moving the expected output into individual files (rather than inline)
to keep the test script much easier to read.

emacs: Remove the joke from the first line of the notmuch-hello view.

Overuse just makes the joke unfunny.

test: Add the most rudimentary testing of the emacs interface.

So far, this is doing nothing more than adding a corpus of email and
ensuring that the `notmuch-hello' function produces the desired
output.

test: Add a new test_emacs function to test-lib.sh

This should be quite handy for doing automated testing of the
emacs-based functionality in notmuch. This function invokes emacs with
the necessary command-line arguments, (to run in batch mode with no
local initialization, to load the notmuch code from the source
directory, and to ensure an 80-column width).

test: Fix add_email_corpus function to be quiet.

This simply avoids some unneeded noise in the "make test" output.

emacs: Fix notmuch-hello to not break when given a very narrow window.

Simply ensure that some subtractions never result in a negative
number, (since emacs complains when asked to create a string with a
negative length).

TODO: Add some notes to fix some recently noted problems.

Just don't want to forget about things that people have pointed out.

emacs: Fix bug when parsing a subject cotaining: \[[0-9/]\]

That is, a subject with a bracketed set of digits (and optionally a
slash), for example "[2010]" would cause the emacs code to misparse
the search results. Fix this by tweaking the regular expression.

lib: Fix "make install"

This has been broken since the addition of the test sub-directory to our
non-recursive make system.

test/README: Document add_email_corpus (and add_message/generate_message)

While adding the documentation here for add_email_corpus I noticed
that the other email-adding functions in test-lib.sh were not yet
documented here, so add all of that documentation.

test: Fix the search and dump-restore tests to operator on non-empty mail store.

We do this with a new add_email_corpus function that establishes a
mail store with 50 messages from the notmuch mailing list.

test: Add a corpus of email messages to be used in testing.

This is simply 50 messages from the early history of the notmuch mailing
list, (fetched from the public archives).

test: Remove useless NOTMUCH variable (in favor of simply "notmuch")

When the NOTMUCH variable was originally invented it was used as an
explicit path to the notmuch binary being tested. Today, the test
suite sets the PATH variable instead, so the NOTMUCH variable always
has a value of simply "notmuch".

We simplifying that by using the constant value rather than the
continual variable reference.

test: Remove some dead code in test-lib.sh

These assignements weren't being used at all and were just confusing me,
(the real assignments happen later on in the file).

test: Fix PATH-checking test to work with --valgrind

The --valgrind option munges the PATH variable, so un-munge it before
testing that we have PATH pointing to the source directory.

lib: Fix use-after-free bug.

Thanks to the new git-based test suite, it's easy to run the whole
test suite in valgrind, (simply "make test OPTIONS="--valgrind"), and
doing so showed this obvious use-after-free bug, (triggered by the
thread-order tests).

test: Fix to actually report errors (!).

A bug in the results-aggregation code was causing the test suite to report
"all tests passed" even when there were failures, (as long as there were
also no "broken" tests). Fix this.

test: Avoid printing "Testing Testing ..."

The test suite isn't auditioning for a roadie position, after all.

test: Print section names, and rename all test sections

Now that we can usefully pass section names via the NOTMUCH_SKIP_TESTS
environment variable, it's useful to actually print those names out
for the user. Then, since we're now printing these names, let's use
nicer names, (not excessively long but also not using abbreviations
like "msg").

test: Make the --valgrind option useful, (and drop --verbose).

In order for --valgrind to be useful, we drop noisy additional output of
all of the commands being executed in verbose mode. This makes --verbose
alone quite useless, so we don't document it any more.

Also, add a zlib valgrind suppression that was showing up frequently in the
test suite.

test/README: Update to become notmuch-specific rather than git-specific

This file was obviously describing the git test suite previously, and
would have been very hard to understand in the context of the notmuch
test suite. HOpefully it's easier to follow now.

test: Rename GIT_SKIP_TESTS to NOTMUCH_SKIP_TESTS

By scanning test-lib.sh for occurrences of "git" or "GIT", I found
that most of those are internal things, (like the GIT_TEST_TEE_STARTED
variable). But GIT_SKIP_TESTS is part of the user-interface to the
test suite, so we rename it to reference notmuch rather than git.

Also, the GIT_TRACE warning is git-specific, so we drop that as well.

test: Fix notmuch-test to pass command-line arguments to sub-scripts.

The is useful for things like "notmuch-test --valgrind", etc.

test: Fix test suite so that --valgrind option works.

The output is ugly, and we need a better suppressions file, but this
is at least a start.

test: Add test to ensure that all available test scripts are run

Since we are now using an explicit list of tests to run in
notmuch-test we need to be careful that we don't add a new file of
tests and then forget to add it to the list.

test: Rename all tests to get rid of the ugly numbers in file names.

The numbers were meaningless, and they made it hard to find a file of interest.

Instead, we get the ordering we want by adding an explicit list of
tests to run to the notmuch-test script.

test: Remove basic testing of broken, fixed, and skipped tests.

These were interfering with the aggregate statistics reported at the
end of the test-suite run. (Always reporting 1 broken, 1 fixed, and 1
skipped). The correct way to test the test-suite itself would be to
run the test suite externally for these cases, capture the expected
result, and then report that as a PASS test.

But, really, there's almost no value in these tests anyway. It's
almost to the level of testing that 'if false; exit 1; fi' returns
1. That is, there are so many ways that the test suite could be broken
internally, that these minor tests don't really help.

test: Fix ordering of tests in t0000-basic.sh

The basic notmuch tests depend on the test-suite harness working, so
test it first.

test: Rework test-suite input to avoid ulti-command strings

The original git test suite works by concatenating many commands into
a very long string (each separated by &&). This is painful to work
with since it prevents the editor from helping by parsing the shell
script, indenting, colorizing, etc.

Instead, we switch this back to something like the original notmuch
test suite, and add two new functions to test-lib.sh
(test_begin_subtest and test_expect_equal) to support these.

This also fixes the test suite to once again display the diff when a
test fails to generate the expected input.

test: Cleanup the test output

This makes the new, git-derived test suite report results in a manner
similar to the original notmuch test suite.

Notable changes include:

  * No more initial '*' on every line
  * Only colorize a single word
  * Don't print useless test numbers
  * Use "PASS" in place of "ok"
  * Begin sentences with a capital letter
  * Print test descriptions for each block
  * Separate each block of tests with a blank line
  * Don't summarize counts between each block

test: Fix test suite to integrate with our non-recursive Makefile system.

This avoids "make test" emitting messages from three (3!) recursive
invocations of make. We change the invocations of the tests themselves
to occur directly from the shell script rather than having the shell
script invoke make again and using wildcards in the Makefile.

test: Set all times to UTC

In order to have repeatable test suite, all times in messages are set
to UTC time zone to match the time zone (TZ variable) set in
test-lib.sh.

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

Convert the actual tests to the new framework

The changes are:
- The notmuch-test was split into several files (t000?-*.sh).
- Removed helper functions which were moved to test-lib.sh
- Replaced every printf with test_expect_success.
- Test commands chained with && (test-lib.sh doesn't use "set -e" in
  order to complete the test suite even if something fails)
- Many variables such as ${MAIL_DIR} were properly quoted as they
  contain spaces.
- Changed quoting patterns in add_message and generate_message (single
  quotes are already used by the test framework).
- ${TEST_DIR} replaced by ${PWD}

QUICK HOWTO:

To run the whole test suite
    make

To run only a single test
   ./t0001-new.sh

To stop on the first error
   ./t0001-new.sh -i
then mail store and database can be inspected in
"trash directory.t0001-new"

To see the output of tests
   ./t0001-new.sh -v

To not remove trash directory at the end:
   ./t0001-new.sh -d

To run all tests verbosely:
   make GIT_TEST_OPTS="-v"

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

test: Update helper functions

Modify the helper functions to work with git-based test suite i.e.
1) Quote arguments where it is necessary.
2) Do not use $NOTMUCH. It is equal to "notmuch" since $PATH is set to
   the build tree.
3) Modify pass_if_equal to fit into the git-based test suite.

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

Update test framework for use with notmuch

This removes Git specific things from the test-lib.sh and adds helper
functions for notmuch taken from Carl's notmuch-test script. README is
also slightly modified to reflect the current state.

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

Copy test framework from Git

Git uses a simple and yet powerful test framework, written in shell.
The framework is easy to use for both users and developers so I think
it would help if it is used in notmuch as well.

This is a copy of Git's test framework from commit
b6b0afdc30e066788592ca07c9a6c6936c68cc11 in git repository.

Signed-off-by: Michal Sojka <sojkam1@fel.cvut.cz>

emacs: Allow '|' to operate on multiple messages (by means of prefix argument).

We extend the '|' command so that passing a prefix argument, (for
example, "C-u |"), causes it to pipe all open messages in the current
thread rather than just the single, current message.

notmuch show: Add documentation of --format=mbox

Shame on me for adding a feature without documenting it at the same
time.

emacs: Fix line-wrapping for help message of notmuch-show mode.

This was previously wrapped for unsubtituted command names. It looks
much better in the notmuch-help (available with '?') if wrapped
according to the length of the substituted command names.

Avoid segmentation fault with NOTMUCH_CONFIG=/new/config/file notmuch setup

Since commit f41a35e2923b0b3ef2f66e91cd30e20b4c1a336a running a command
such as:

NOTMUCH_CONFIG=/new/config/file notmuch setup

would result in a segmentation fault.

The purpose of that commit was to ensure that an attempt to manipulate
a non-standard database would not inadvertently manipulate the default
database only due to a typo in the NOTMUCH_CONFIG environment
variable. That is, a command like:

NOTMUCH_CONFIG=mistyped-config-filename notmuch tag -new tag:new

shouldn't modify the database at ${HOME}/mail, but should instead
simply report that the mistype configuration filename does not exist.

We fix both cases simultaneously by reporting the error message
whenever the function calling notmuch_config_open is not explicitly
prepared for a default configuration file.

NEWS: Document the new "notmuch show --format=mbox" format

I'm trying to get into the habit of maintaining the NEWS file as I go.

notmuch show: Add a --format=mbox option

We don't love the mbox format, but it's still sometimes the most
practical way to share a collection of messages as a single file.

Here we implement the "mboxrd" variant of the mbox file format. This
variant applies reversible escaping by prefixing a '>' character to
all lines in the email messages matching the regular expression:

"^>*From "

This allows the escaping to be reliably removed. A reader should remove
a '>' from any line matching the regular expression:

"^>>*From "

More details on the mboxrd formats (and others as well) can be found
here:

http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html

Fix minor style issues in show_part_content function.

I was recently editing the code in this function and decided to clean
it up a bit.

Avoid giving GMime a NULL MIME-stream filter.

Micah Anderson reported an issue where a message failed to display in
the emacs interface, (it instead gave an error, "json-read-string: Bad
string format").

Micah tracked this down to the json output from "notmuch show" being
interrupted by a GMime error message:

gmime-CRITICAL **: g_mime_stream_filter_add: assertion
`GMIME_IS_FILTER (filter)

I tracked this down further to notmuch passing a NULL value to
g_mime_stream_filter_add. And this was due to calling
g_mime_filter_charset_new with a value of "unknown-8bit".

So we add a test message withe a Conten-Type of "text/plain;
charset=unknown-8bit" from Micah's message. Then we fix "notmuch show"
to test for NULL before calling g_mime_stream_filter_add. Bug fixed.

Add C-tab binding in notmuch-search mode as well.

We recently added this to notmuch-hello mode so we might as well
support it in this mode as well for consistency.

make install: Run ldconfig or install a DT_RUNPATH in binary as appropriate.

Various users were confused as to why they couldn't run notmuch
immediately after "make install", (with linker errors saying that
libnotmuch.so could not be found). The errors came from two different
causes:

1. The user had installed to a system library directory, but had not
   yet run ldconfig.

2. The user had installed to some non-system directory, and had not
   set the LD_LIBRARY_PATH variable.

With this change we fix both problems (on Linux) without the user
having to do anything additional. We first use ldconfig to find the
system library directories. If the user is installing to one of these,
then we run ldconfig as part of "make install".

For case (2) we use the -rpath and --enable-new-dtags linker options
to install a DT_RUNPATH entry in the binary. This entry tells the
dynamic linker where to find libnotmuch. Without the
--enable-new-dtags option only a DT_RPATH option would be installed,
(which has the drawback of not allowing any override with the
LD_LIBRARY_PATH variable).

Distributions (such as Debian and Fedora) don't want to see binaries
packaged with a DT_RPATH or DT_RUNPATH entry. This should be avoided
automatically as long as the packages install to standard locations,
(such as /usr/lib).

configure: Remove space from IFS (using tab as necessary)

The idea here is to more easily support filenames with spaces in them
in various loops. We're about to add a loop over the paths configured
by the dynamic linker. Hopefully, they wouldn't contain spaces, but
one never knows so we might as well be prepared.

Add support (and tests) for messages with really long message IDs.

Scott Henson reported an internal error that occurred when he tried to
add a message that referenced another message with a message ID well
over 300 characters in length. The bug here was running into a Xapian
limit for the length of metadata key names, (which is even more
restrictive than the Xapian limit for the length of terms).

We fix this by noticing long message ID values and instead using a
message ID of the form "notmuch-sha1-<sha1_sum_of_message_id>". That
is, we use SHA1 to generate a compressed, (but still unique), version
of the message ID.

We add support to the test suite to exercise this fix. The tests add a
message referencing the long message ID, then add the message with the
long message ID, then finally add another message referencing the long
ID. Each of these tests exercise different code paths where the
special handling is implemented.

A final test ensures that all three messages are stitched together
into a single thread---guaranteeing that the three code paths all act
consistently.

test suite: Generate message filenames from count, not Message-Id.

We're about to add a test with an excessively long message-id, (512
characters or so). This exceeds filename length limits, so just always
the simple counter to generate the filenames, (which we were doing for
messages with non-custom IDs anyway).

test suite: Add support for custom references header in generated messages.

In the same style as several other existing headers.

Avoid database corruption by not adding partially-constructed mail documents.

Previously we were using Xapian's add_document to allocate document ID
values for notmuch_message_t objects.  This had the drawback of adding
a partially constructed mail document to the database. If notmuch was
subsequently interrupted before fully populating this document, then
later runs would be quite confused when seeing the partial documents.

There are reports from the wild of people hitting internal errors of
the form "Message ... has no thread ID" for example, (which is
currently an unrecoverable error).

We fix this by manually allocating document IDs without adding
documents. With this change, we never call Xapian's add_document
method, but only replace_document with either the current document ID
of a message or a new one that we have allocated.

Fix misnamed function in internal documentation.

The documentation for several functions mentioned
_notmuch_message_set_sync which doesn't exist. Fix these to reference
_notmuch_message_sync instead.

emacs: Tags should be shown with `notmuch-tag-face'.

Use the same face for tags in `notmuch-show' mode as that used in
`notmuch-search' mode.

emacs: In search mode, truncate authors using invisible text.

Rather than discarding authors when truncated to fit the defined
column width, mark the text beyond the end of the column as invisible
and allow `isearch' to be used over the text so hidden.

This allows us to retain the compact display whilst enabling a user to
find the elided text.

emacs: Adjust comment to avoid confusing font-lock.

Comments with an open bracket in the first column confuse `font-lock'
mode, so avoid them.

emacs: Allow the display of absolute dates in the header line.

Add `notmuch-show-relative-dates' to control whether the summary line
in `notmuch-show' mode displays relative dates (e.g. '26 mins. ago') or
the full date string from the message. Default to `t' for
compatibility with the previous behaviour.

emacs: Bind <backtab> (shift-TAB) to notmuch-show-previous-button

Shift-TAB is standard "opposite" of TAB -- in GUI interfaces they
typically cycle through input elements in opposite orders -- so it
makes sense to behave the same way.

Signed-off-by: Nelson Elhage <nelhage@ksplice.com>

emacs: More functionality for `notmuch-wash-tidy-citations'.

Add:
- Insert a blank line before a citation if there isn't one,
- Insert a blank line after a citation if there isn't one.

emacs: Pretty print the numbers of matching messages.

Insert a separator every three digits when outputting numbers. Allow
the user to choose the separator by customizing
`notmuch-decimal-separator'. Widen the space allocated for message
counts accordingly.

emacs: notmuch-hello: Make widget-keymap a parent of notmuch-hello-keymap

This lets us pick up later changes to widget-keymap if the user
customizes it in some way. This is the recommended way to use
`widget-keymap', according to its help.

add missing docstring for functions

The '?' key bindings uses them for the help window and these are
currently empty.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

Make notmuch-hello a mode.

This enables the nifty '?' key binding to work in notmuch-hello
(although for some strange reasons I don't see any descriptions for
specific key bindings yet. Not sure how that is supposed to work
though.
But this starts, runs and behaves identical to the existing code.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

emacs: Remove notmuch-hello-roundup function

as it does the same as (ceiling number divisor) which is already provided in elisp.

Add support for the Solaris platform

Like on Mac OS X, the linker doesn't automatically resolve dependencies.

Signed-off-by: Tomas Carnecky <tom@dbservice.com>

configure: Respect LDFLAGS from the environment.

The configure usage string documents that it respects LDFLAGS, but
currently it doesn't do anything with the configure-time LDFLAGS
value.

Signed-off-by: Tomas Carnecky <tom@dbservice.com>
[Tomas and Nelson sent almost identical patches which I've merged
together here.]

emacs: In hello mode, bind `C-tab' to move backwards through widgets.

`C-tab' is now the inverse operation to `tab'.

emacs: Reuse rather than reinvent message header filtering

In notmuch-mua-reply we were filtering out the Subject and To headers
manually in a loop, but message mode offers a nice function for
exactly that. Simplify the code by using it. Also, as notmuch-mua-mail
already sorts and hides headers that we want sorted and hidden, we can
safely remove those 2 functions from here as well.  Also remove the
(require 'cl), the only reason for its existence was the now removed
"loop" function.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

emacs: Allow tuning of the tag/saved search layout.

Add `notmuch-column-control', which has three potential sets of
values:

- t: automatically calculate the number of columns per line based on
  the tags to be shown and the window width,
- an integer: a lower bound on the number of characters that will be
  used to display each column,
- a float: a fraction of the window width that is the lower bound on
  the number of characters that should be used for each column.

So:
- if you would like two columns of tags, set this to 0.5.
- if you would like a single column of tags, set this to 1.0.
- if you would like tags to be 30 characters wide, set this to
  30.
- if you don't want to worry about all of this nonsense, leave
  this set to `t'.

emacs: Allow control over faces for search mode columns.

Add face declarations for the date, count, matching author and subject
columns in search mode and apply those faces when building the search
mode display.

Approved-by: Jameson Rollins <jrollins@finestructure.net>

emacs: Set the `face' property rather than `font-lock-face'.

Avoid using face properties reserved for the font-lock package.

emacs: Display non-matching authors with a different face.

In search mode some messages don't match the search criteria. Show
their authors names with a different face - generally darker than
those that do match.

NEWS: describe easier FCC configuration

I know I should be writing something witty here to make cworth happy,
but I can't think for any verbose justification of this patch beyond
that submitting a NEWS blurb will make cworth happy too. So let's make
him happy.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

Easier way to define a fcc directory

In the common case that a user only has one FCC (save outgoing mail in
the Mail directory, it is now possible to simply configure a string
such as "Sent" in the notmuch-fcc-dirs variable. More complex options,
depending on a users email address, are possible and described in the
variable customization help text.

The whole function notmuch-fcc-header-setup has been cleaned up a
little while working on that.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

emacs: Usability improvements for `notmuch-hello'.

- If no saved searches exist or are displayed, don't signal an error,
- If no saved searches exist or are displayed, leave the cursor in the
  search bar,
- Minor layout improvements.

Add a test case for the previous commit.

The commit said it fixed a problem with headers >200 characters
long. But examination of the code suggests that it was a header of
exactly 200 characters long that caused the problem. So we add a test
case for that here.

Before the fix in the previous commit, valgrind would detect many
errors when replying to the message created with this test case. After
that commit, those errors are gone.

notmuch: Fix off-by-one errors if a header is >200 characters long.

If a single header is more than 200 characters long a set of 'off by
one' errors cause memory corruption.

When allocating memory with:
     a = malloc (len);
the last usable byte of the memory is 'a + len - 1' rather than 'a +
len'.

Fix the same bug when calculating the current offset should the buffer
used for collecting the output header need to be reallocated.

Makefile: Improve the "what to do now" message from "make install"

This was already telling the user how to run notmuch within emacs, but
not how to just run the notmuch command-line interface, (which, as it
turns out, is a prerequisite for running the emacs interface anyway).

So add a small paragraph here.

INSTALL/README: Clean up the description of how to run the emacs interface.

The INSTALL file still had old information about the "make
install-emacs" command which no longer exists. README was also giving
pointers on how to develop a real interface, (which is not the right
thing since README should be addressed to users, not coders).

So remove the stale and misplaced information, and instead add a new
"Running notmuch" section to the README describing how to run the
notmuch command-line interface and how to run the emacs interface.

INSTALL: Note the advantages of Xapian 1.0.18+ and 1.1.4+

These versions provide greatly desired performance advantages for
notmuch.

Previously, theses details existed in an old NEWS entry, but most
users are unlikely to find those details there. Put them here where we
mention the Xapian dependency.

TODO: Add idea for fixing "notmuch count" to always be exact.

I had previously thought Xapian only offered an estimate for the
number of results that might match a search. But Olly let me know
that we can easily ask for Xapian to provide the exact count.

TODO: Add a note that 'a'rchive should only affect open messages.

To avoid accidentally archiving messages that have not been read.

python: have docs reflect current return value behavior

Database.find_message() used to be able to reliably indicate whether a
message exists or not (in which case it returns None). However, the
recent API change of the notmuch library means we will return None
even for all Xapian exceptions, which happens e.g. when the current
Database has been modified by another project. Therefore the return
value of None cannot be reliably be used to indicate whether a message
exists or not. Make the docs state that explicitely.

Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>

Merge branch '0.3.x' immediately after the 0.3.1 release

This brings one bug fix into master that was originally applied
directly to the 0.3.x branch.

debian: Instruct git-buildpackage that it's OK to build from this branch

I wish I had something with better support for a native Debian package
here. I shouldn't ever have to configure any branch---I just want it
to build a package from the current branch. Instead it makes me tell
it (twice!) what the current branch actually is.

debian/changelog: Copy in content from the NEWS file.

Someday we'll automate this step.

Increment version to 0.3.1

For our 0.3.1 bug-fix release.

NEWS: Reword the latest bug description slightly.

"Still needs to be handled correctly" could be misread to suggest that
the bug has not actually been fixed yet. So clarify what is actually
meant here, (that the bug is unlikely but we're still motivated to fix
it).