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

test: Fix indentation

Fix it to consistently match the style we have configured in
".dir-locals.el".

.dir-locals.el: Set variables for correct "shell" mode

The major mode used for shell scripts is named 'sh-mode'.
'shell-mode' on the other hand implements an interactive
shell in emacs-lisp.

Fix typos

emacs: Increase consistency of library headers

emacs: Various cosmetic changes

emacs: Autoload notmuch-jump using an autoload cookie

Doing that is better than using an `autoload' form because the latter
may result in dependencies getting hidden and indeed it turns out we
have to declare `notmuch-jump' in "notmuch-tag.el".

emacs: Autoload notmuch-jump-search only once

This function is being autoloaded using an autoload cookie, so it
shouldn't additionally be autoloaded using an `autoload' form.

When building libraries we don't actually load the autoloads file and
dropping the `autoload' form results in an error, which reveals a so
far unspecified dependency: `notmuch-tree' needs `notmuch-jump'.

Before this commit compiling (or even just loading) `notmuch-tree'
resulted in `notmuch-jump' being loaded because the former requires
`notmuch-lib', which autoloaded `notmuch-jump-search'.

The bug was that this dependency was not explicitly specified, which
we fix by adding the respective `require' form.

emacs: Improve doc-strings

- The first sentence should fit on the first line in full.  This is
  even the case when that causes the line to get a bit long.  If it
  gets very long, then it should be made shorter.

- Even even the second sentence would fit on the first line, if it
  just provides some details, then it shouldn't be done.

- Symbols are quoted like `so'.

- There is no clear rule on how to (not) quote non-atomic
  s-expressions, but quoting like '(this) is definitely weird.

- It is a good idea to remember that \" becomes " and to take
  that in mind when adjusting the automatic filling by hand.

- Use the imperative form.

- Arguments are written in all uppercase.

emacs: Use makefile-gmake-mode in Makefile*s

Use `makefile-gmake-mode' instead of `makefile-mode' because the
former also highlights ifdef et al. while the latter does not.

"./Makefile.global" and one "Makefile.local" failed to specify any
major mode at all but doing so is necessary because Emacs does not
automatically figure out that these are Makefiles (of any flavor).

emacs: notmuch-poll: Let the user know we are polling

It is done synchronously and it can take a while,
so we should let the user know what is going on.

emacs: No longer define notmuch-hello-mode-map as a function

It was defined as such for a decade; ever since
a56010ac8b89a2489eee5c78469f05cee85ec858 but there
wasn't a reason to do that then nor is there now.

emacs: Fix some function declarations

emacs: Extend face to window edge again

Since Emacs 27 each face has to be explicitly configured to "extend
to the edge of the window".  Without doing that the face used for
the newline character only has an effect that spans "one character"
(i.e. it looks like there is a single trailing space character).

We don't want that so extend the face in Emacs 27, so that it looks
the same as it did in older Emacs releases.  We have to do this
conditionally, otherwise older Emacsen would choke on it.

emacs: Use one or three lines for 'if' forms

Putting the COND and THEN parts on the same line but ELSE on a
separate line makes it harder to determine if there actually is
an ELSE part.

emacs: Use 'when' instead of 'if' when there is no ELSE part

emacs: Use 'unless' instead of 'when' and 'not'

Also use 'unless' in a few cases where previously 'if' was used with
'not' but without an ELSE part.

emacs: Use 'and' instead of 'when' when the return value matters

Also do so for some 'if' forms that lack an ELSE part.
Even go as far as using 'and' and 'not' instead of 'unless'.

emacs: Only set one variable per setq form

It's a bit weird to avoid having to write the "(setq ... )" more than
once, just because we can.  In a language that uses '=' for the same
purpose we also happily use that once per assignment.

While there are no benefit to using just one 'setq' there are some
drawbacks.  It is not always clear on first what is a key and what a
value and as a result it is easy to make a mistake.  Also it becomes
harder to comment out just one assignment.

emacs: Closing parenthesis go on the same line

emacs: Fix indentation

emacs: Remove excess empty lines

Most people who write lots of lisp tend to only sparsely use empty
"separator" lines within forms.  In lisp they feel unnecessary and
since most files stick to this convention we get a bit confused
when there are extra empty lines.  It feels like the s-expressions
are falling into pieces.

All of this is especially true between a function's doc-string and
body because the doc-string is colored differently, which visually
already separates it quite sufficiently from the code that follows.

emacs: Shorten long lines

Emacs: Ensure left-to-right display for message headers

In notmuch-show buffer insert invisible U+200E LEFT-TO-RIGHT MARK
character at the beginning of message header paragraph if the From
header contains a right-to-left character. This ensures that the
header paragraph is always rendered in left-to-right mode.

See Emacs Lisp reference manual section "(elisp) Bidirectional
Display" for more info.

T355: specify hash algorithm explicitly

On some systems (notably, the one shipped with LibreSSL),
default fingerprint digest algorithm is SHA256.

On other systems, users can change default digest algorithm by changing
default_md in /etc/ssl/default_md.

Let's ask openssl to provide us specific algorithm to make the test
more deterministic.

Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>

configure: drop check for default xapian backend

Starting from xapian 1.3.5, xapian switched default backend to glass.

From 00cdfe10 (build: drop support for xapian versions less than 1.4,
2020-04-22), we only support xapian 1.4.0+. Effectively, we don't need
to check for default xapian backend anymore.

Further more, from 99a7aac8 (test: drop use of db_ending, 2020-07-29),
our test framework has become independence from default xapian.

Let's drop it.

Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>

configure: check for pytest with python -m pytest

On different distro, pytest is suffixed with different patterns.

On the other hand, `python3-pytest' could be invoked correctly,
via `python3 -m pytest', the latter is used by our tests, now.

Switch to `$python -m pytest` to fix address all incompatible naming.

Signed-off-by: Đoàn Trần Công Danh <congdanhqx@gmail.com>

test: regression tests for n_indexopts_{get,set}_decrypt_policy

The main criteria is that they don't crash. Working with a closed
database is a bonus.

test: regression test for traversing config list with closed db

Also mention error return in API docs

test: regression test for n_d_get_config_list on closed db.

Exception is caught.

test: regression test for n_directory_{get,set}_mtime

The mtime is cached, so closing the db is not a problem. Writing the
mtime throws an exception, which is caught.

lib: fix return value for n_directory_delete

Falling out of the catch meant the error return was lost

test: known broken test for n_directory_delete with closed db.

There is a return value bug in notmuch_directory_delete that is hiding
the exception.

lib: catch exceptions in n_directory_get_child_files

Also clarify API in error case.

test: add known broken test for n_directory_get_child_files

This is a clone of the one for get_child_directories

lib: catch exceptions in n_directory_get_child_directories

Also clarify API in error case.

test: add known broken test for n_directory_get_child_directories

Start a new test file (for the notmuch_directory_* API group) to hold
this test.

test: regression test for n_m_get_filenames

Closing the database after the iterator is created is not a problem.

test: split header for lib-message tests.

This allows finer control over when to close the database.