Merge branch 'release'

Commit Debian 3.0 (quilt) metadata

[dgit (9.12) quilt-fixup]

debian: changelog for 0.31.2-4

build/docs: move docstring prereq to file targets

Under a sufficiently high level of parallelism [1] there seems to be a
a race condition that allows sphinx-build to start running before the
docstrings are extracted. This change moves the docstring stamp from
the phony targets sphinx-html and sphinx-info to the file targets that
they depend on. I'm not sure why this makes things better, but I am
fairly confident it does not make things worse, and experimentally it
seems to eliminate the race condition.

[1]: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=976934

emacs: avoid binding unnamed commands in keymaps

One should never bind unnamed commands in keymaps because doing that
makes it needlessly hard for users to change these bindings.

Replace such anonymous bindings with named commands that are generated
using macros and some boilerplate. Using macros is better than using a
simple loop because that makes it possible for `find-function' to find
the definitions. Eat your boilerplate--it forms character.

Admittedly this approach is quite ugly and it might be better to teach
the original commands to support different buffers directly instead of
requiring wrapper commands to do just that.

Never-the-less as a short-term solution this is better than what we
had before.

emacs: do not quote self-quoting t

emacs: use setq-local

It is available since Emacs 24.3 and we require at least Emacs 25.
It makes the variable buffer-local if it isn't always buffer-local
anyway.

emacs: use defvar-local

It is available since Emacs 24.3 and we require at least Emacs 25.

emacs: inline notmuch-split-content-type

This trivial helper function actually made things slightly
*less* readable by adding an unnecessary indirection.

emacs: inline notmuch-documentation-first-line

Inline a simplified version of `notmuch-documentation-first-line'
into its only caller.  The new code snippet differs from the
removed function in that it returns nil instead of the empty string
for symbols that have no function documentation.  That value is
ultimately used as an argument to `concat', which treats nil like
the empty string.  So we can do the logical thing without changing
the behavior.

emacs: remove unnecessary notmuch-tree-button-activate

Since [1: f8bdba37] no key is bound to this command and it is
redundant because the behavior of `push-command' is identical
when called as a command.

1: f8bdba37d3f4c877e05e17b5b1c7d2d512106538
   emacs: tree: remove binding for pressing button in message pane

emacs: remove unused notmuch-address-locate-command

We stopped using it in [1: 0e671478].

1: 0e671478c6f37018973392f049979da5e1a8ff99
   emacs: replace use of notmuch-address-message-insinuate

emacs: remove unnecessary notmuch-remove-if-not

We could just have switched to using `cl-remove-if-not' instead,
but the two uses of the *remove-if-not function are pretty strange
to begin with so we refactor to not use any such function at all.

emacs: remove deprecated notmuch-folder command

It has been deprecated for a decade and it's time to let go.

emacs: misc doc-string improvements

emacs: always use elisp quoting style in doc-strings

Emacs doc-strings use neither markdown nor lisp symbol quoting.

emacs: place complete first sentence on first doc-string line

emacs: place only first sentence on first doc-string line

emacs: shorten/replace first sentence of a few doc-strings

The first sentence should fit on the first line.  It is okay if
the first sentence/line does not contain all the information that
the rest of the doc-string covers.

emacs: define notmuch-hello-url as a constant

emacs: sanitize function that displays version

Previously it was defined in "notmuch-hello.el" and its name contained
"hello" solely because it replaced an anonymous function that was
mistakenly only bound in `notmuch-hello-mode-map'.  But it makes more
sense to bind it in all notmuch modes and even if we did not change
that aspect it still would make no sense to have "hello" in its name.

emacs: more cleanup since dropping support for Emacs 24

Notmuch requires at least version 25 of Emacs now.

Adjust comments that previously referenced version 24 specifically,
even though they also apply to later releases. Remove documentation
and code that no longer applies.

- `mm-shr' no longer references `gnus-inhibit-images'.

emacs: remove kludge for Emacs 23 from notmuch-mua-mail

Notmuch requires at least Emacs version 25.

The `return-action' argument was added prior to Emacs 24.1
in 25ca2e61403f97b5a023164f2924d5f8aca2492a.

emacs: fix old bug in notmuch-mua-mail

This fixes a regression introduced in [1: 7e20d264].  If the argument
RETURN-ACTION was non-nil then we should pass along the value of that
argument.  Instead we passed along the constant symbol `return-action'.

1: 7e20d26480553f57d53bd9ec28cae163c1ac91e3
   emacs: Fix mail composition under Emacs 23

emacs: remove redundant notmuch-hello-trim

Use `string-trim', which exists since Emacs 24.4.

emacs: don't fset keymaps

These keymaps are never invoked as commands
so the function definitions serve no purpose.

emacs: add doc-string to notmuch-tree-mode-map

emacs: define notmuch-message-mode-map explicitly

Key bindings should not be defined at the top-level but inside
a `defvar' form.  Doing it at the top-level makes it harder to
reliably customize key bindings.

emacs: silence byte-compiler

debian: upload 0.31.2-3

debian: changelog for 0.31.2-2

debian: run tests in verbose mode

A hopefully temporary change to try and debug some test failures on
autobuilders.

release: explicitely build sphinx-html

This is to force it to happen after the "make clean".

NEWS: update for 0.31.2

debian: remove quilt patches

These were generated by dgit due a mix up with .orig.tar.xz files.

debian: update changelog for 0.31.2-1

version: bump to 0.31.2

build: change one more occurrence of 'version' to 'version.txt'.

This one disguised via tar and sed trickery.

Commit Debian 3.0 (quilt) metadata

[dgit (9.12) quilt-fixup]

release: call python3 instead of python

Debian does not install /usr/bin/python by default any more.

release: update release-checks.sh for s/version/version.txt/

Another place missed by the rename.

debian: changelog for 0.31.1-1

NEWS: add news for 0.31.1

update versions

build: fix update-versions rule

This was missed in the rename of the 'version' file to version.txt

Rename version to version.txt

Building Notmuch on macOS is known to cause problems because the Notmuch
distribution archive contains two files named "version". These names
clash with the <version> header as defined in C++20. Therefore, the
existing naming will likely become a problem on other platforms as well,
once compilers adopt the new standard.

Signed-off-by: Ralph Seichter <github@seichter.de>
Amended-by: db s/keyword/header/ in commit message.

lib/config: don't set destructor until iterator is initialized.

As diagnosed by Olivier Taïbi in
id:20201027100916.emry3k2wujod4xnl@galois.lan, if an exception is
thrown while the initialization is happening (e.g. if the function is
called on a closed database), then the destructor is (sometimes)
invoked on an uninitialized Xapian object.

Solve the problem by moving the setting of the destructor until after
the placement new successfully completes. It is conceivable this might
cause a memory leak, but that seems preferable to crashing, and in any
case, there seems to be nothing better to be done if the
initialization is failing things are in an undefined state by
definition.

configure: replace $(realpath emacs) with $(cd emacs && pwd -P)

For portability; the realpath command (e.g. from GNU coreutils)
is not so common outside Linux systems.

The "$(cd emacs && pwd -P)" replaces that realpath(1) execution
suitably in this context (using just bash(1) builtins).

emacs docs: rstdoc.el: consistent single quote conversions

With text-quoting-style 'grave keeps "'" and "`" quotes unaltered
for further processing done by this code (regardless of locale...).
The tools that read the reStructuredText markup generated can do
their styling instead.

Added temporary conversions of ' and ` to \001 and \002 so that
's and `s outside of `...' and `...` are converted separately
('s restored back to ' and `s converted to \`).

Both `...' and `...` are finally "converted" to `...` (not ``...``).
https://docutils.sourceforge.io/docs/user/rst/quickref.html documents
that as `interpreted text`:

 "The rendering and meaning of interpreted text is domain- or
  application-dependent. It can be used for things like index
  entries or explicit descriptive markup (like program identifiers)."

Which looks pretty much right.

emacs: Remove notmuch-mua-message-send-hook

Currently `message-send-hook` functions are being called twice: In
notmuch send common when `notmuch-mua-send-hook` functions are
run (which by default includes `notmuch-mua-message-send-hook`) and in
`message-send` itself.

Because `message-send-hook` functions are run in `message-send` itself,
we don't need also need to run them before we delegate to `message-send`

Calling `notmuch-mua-message-send-hook` resulted in functions in
`message-send-hook` to be called twice. This causes bugs in
non-idempotent hook functions.

Merge tag '0.31' into master

notmuch 0.31 release

NEWS: set release date

debian: changelog for 0.31-1

version: bump to 0.31

News: add entry for unthreaded mode

A belated NEWS entry for the new un-threaded mode introduced in Notmuch
0.30.

test: fix syntax errors in erroring calls to notmuch insert

notmuch insert does not currently support passing a filename for the
input, so all of these tests have an extra error in addition to the
one being tested for.

Currently this does not make a difference because the error being
tested for is caught before the error of an extra command line
argument. In the future it might make a difference, and in any case it
is confusing.

NEWS: mention reproducibility fix

NEWS: mention Emacs 27.1 compatibility fixes

version: bump to 0.31~rc2

debian: drop notmuch-emacs dependency package

elpa-notmuch is now present in oldstable, and we don't need to support
direct upgrades from older releases than that.

debian: suggest mailscripts

These contain several useful tools for the notmuch user, particularly
on Debian.

debian: suggest elpa-mailscripts

These contain some useful functions for notmuch users, mainly wrappers
for scripts from mailscripts.

NEWS: remaining user visible library changes

These could both cause / fix crashes for user code.

NEWS: mention new API entries

NEWS: mention port to Xapian 1.5

NEWS: mention exception handling changes

NEWS: mention merging of documentation for python bindings

NEWS: add news entry for tree navigation changes

Signed-off-by: William Casarin <jb55@jb55.com>
Amended-by: db, add verb

Emacs: Fix notmuch-message-summary-face definition

Emacs face definition forms are either

    ((DISPLAY . PLIST)
     (DISPLAY . PLIST))

or

    ((DISPLAY PLIST)   ;For backward compatibility.
     (DISPLAY PLIST))

Commit a2388bc56e55da5d5695816818274f8a84b0ed92 (2020-08-08) follows
neither of the correct formats. It defines:

    `((((class color) (background light))
       ,@(and (>= emacs-major-version 27) '(:extend t))
       (:background "#f0f0f0"))
      (((class color) (background dark))
       ,@(and (>= emacs-major-version 27) '(:extend t))
       (:background "#303030")))

which produces:

    ((DISPLAY
      :extend t (:background "#f0f0f0"))
     (DISPLAY
      :extend t (:background "#303030")))

And that is wrong format.

This change fixes the face definition form to produce:

    ((DISPLAY
      :extend t :background "#f0f0f0")
     (DISPLAY
      :extend t :background "#303030"))

which follows the (DISPLAY . PLIST) format (see above).

AUTHORS: update for 0.31

Just shuffles existing authors around, mainly due to Jonas's
enthusiastic cleanup work.

emacs: Use pop-to-buffer-same-window rather than switch-to-buffer

This means that notmuch commands obey display-buffer-alist so the user
can customize how buffers show up.

It also permits the use of C-x 4 4, C-x 5 5 and C-x t t, available in
Emacs 28.  For example, one can use C-x 4 4 M-x notmuch-jump-search RET
to open a saved search in another window rather than the current window.
Or in notmuch-search mode, C-x 5 5 RET to view the message at point in
a new frame.

notmuch-tree has custom buffer display logic, so bind
display-buffer-overriding-action to make pop-to-buffer-same-window
behave exactly as switch-to-buffer while that function is running.

debian/changelog: fix typo

update changelog for 0.31~rc1-1

version: bump to 0.31~rc1

NEWS: notmuch-mutt: system(shell pipeline) replaced internally

test: fix uninitialized variable use in T562-lib-database

Fix a copy paste error of using the boolean ret as a notmuch_status_t,
and uninitialized.

build: clean up sphinx.config

Follow the existing practice and remove it under "distclean", same as
sh.config and Makefile.config

devel/release-checks.sh: use grep to find copyright year.

This is quite fragile, but it works for now, unlike the python
version.

In general it seems conf.py is not intended to be evaluated outside of
sphinx, as it assumes certain global names (in particular "tags") are
defined.

debian: update symbols for 0.31

Two new API entries for better error handling

debian: start changelog for 0.31~rc0-1

version: bump to 0.31~rc0

Start the release process for 0.31

emacs/tree: add notmuch-tree-archive-thread-then-next

Now that notmuch-tree-next-thread acts more like its notmuch-show
counterpart, let's update the binding to move to the next thread after
archiving.

Signed-off-by: William Casarin <jb55@jb55.com>

emacs/tree: enable moving to next thread in search results

This introduces a new function called
notmuch-tree-next-thread-from-search which is analogous to
notmuch-show-next-thread. It will switch to the next or previous
thread from the parent search results.

We rename notmuch-tree-{prev,next}-thread to a more descriptive
notmuch-tree-{prev,next}-thread-in-tree to reflect the fact that it
only moves to the next thread in the current tree.

notmuch-tree-next-thread now switches to the next thread in the
current tree first, but if there are none, it looks for the next tree
in the search results.

This makes notmuch-tree feel more like notmuch-show when using the
M-Enter, M-n and M-p bindings.

Signed-off-by: William Casarin <jb55@jb55.com>

emacs/tree: introduce notmuch-tree-parent-buffer variable

This variable will be used in a similar fashion to
notmuch-show-parent-buffer. It will be used to navigate between
threads from the parent search buffer.

Signed-off-by: William Casarin <jb55@jb55.com>

test: update README to reflect dropping upgrade tests

These test databases have been unneeded since ee897cab8.

Emacs: Indent first header line only when indentation is turned on

Previously in message-show mode message's first header line (From
header) was always indented, even if user had turned thread
indentation off with "<" (notmuch-show-toggle-thread-indentation)
command.

This change modifies notmuch-show-insert-headerline function so that
it doesn't indent the first header line if notmuch-show-indent-content
variable is nil.

This change also modifies tests so that they expect this new output
format:
test/emacs-show.expected-output/notmuch-show-indent-thread-content-off

notmuch-mutt: replace shell pipeline with internal pipe processing

The shell pipeline used to symlink files based in search results
to "cache" directory for mutt(1) to use was prone to portability
problems (due to /bin/sh differences).

The replacement executes `notmuch search` without intermediate shell
(so shell_quote was removed in this case), reads the filenames from
piped output and symlinks files internally.

configure: Check if emacs >= 25 (instead of >= 24) is available

"The minimum supported major version of GNU Emacs is now 25.1."

25.1 is the first "released" version of Emacs 25.

try-emacs-mua: Trim `require' advice for Emacs 25

- Since Emacs 25 comes with `load-prefer-newer' we can remove the
  complicated variant of the advice, which implemented a poorman's
  version of that.

- Since Emacs 25 comes with the new advice mechanism, we can use
  that now for the simple variant of the advice, which just informs
  about the library that is being required.

emacs: Use new advice mechanism do advice mm-shr

Also because we now only support Emacs >= 25,
we can remove the check for Emacs >= 24.

emacs: Do not abuse advice to monkey patch while testing

Use `cl-letf*' instead.

emacs: Drop old advices that were only need for Emacs 23

emacs: Remove notmuch-read-char-choice

Just use `read-char-choice', which existed since Emacs 24.1.

emacs: Remove notmuch-setq-local

Just use setq-local, which existed since Emacs 24.3.

emacs: Use cl-incf where appropriate

It's shorter.  That's it pretty much.

NEWS: At least Emacs 25.1 is required now

Some backward incompatible changes follow in the next few commits
and going forward contributors don't have to worry about Emacs 24
at all anymore.

NEWS: Add stub for 0.31

emacs: Add end-of-file line to libraries that lack it

emacs: Provide 'rstdoc' feature at end of file

Features should nearly always be provided at the very end of their
libraries.  This feature isn't one of the rare exceptions.

.gitignore: Sort using sort-lines