doc/emacs: document notmuch-cycle-notmuch-buffers

For some reason I couldn't find this when I searched, so add it to the
manual.

doc/emacs: document notmuch-poll*

The current "documentation" for these variables consists of only the
variable names.

doc/emacs: document notmuch-tagging-keys

Calling these "Global keys" is arguably a bit of a stretch, but they
do work in all notmuch modes except notmuch-hello.

doc/emacs: document notmuch-message-headers*

More precisely, copy the docstrings into notmuch-emacs documentation pages.

doc/emacs: add documentation for stashing 'c X' bindings

This is the first of a series of changes requiring the extracted docstrings.

doc/emacs: require extracted docstrings for sphinx or info manual

We need to use the stamp file here in order not to depend on the order
the submakefiles are included.

emacs: build docstring (rsti) files

These are intended to included in the sphinx manual for notmuch-emacs.
The stamp file makes it easier to depend on the docstrings from other
parts of the build

emacs: initial version of rstdoc.el

This small library is intended to support batch extraction of Emacs
Lisp docstrings from source files. Clients will need to include (or
replace) rstdoc.rsti.

reply: Include sender as recipient if they were the original recipient

When generating a reply message, if the user was the originator and
only recipient of the original message, include the user as a
recipient of the reply.

emacs: filter tag completions by current query

When filtering by tags in notmuch-search-filter-by-tag, only return tags
related to the current query.

Before, it was returning all tags. There's no reason to refine the
current query with tags that don't exist in the current result set.

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

cli: notmuch show support for --include-html with --format=text

cli: notmuch show support for --body=false with --format=text

emacs: escape quote in docstring

This prevents emacs from turning it into a fancy, non-evaluable
docstring (and also makes it easier to deal with during extraction to
sphinx).

emacs: require notmuch-lib from notmuch-wash.el

This is needed so that notmuch-wash.el is loadable by itself; in
particular for the docstring processing.

Avoid spurious gcc warning in debugger.c

Without this patch, gcc 8.2.0-7 complains:

debugger.c: In function ‘debugger_is_active’:
debugger.c:40:24: warning: passing argument 2 to restrict-qualified parameter aliases with argument 1 [-Wrestrict]
     if (readlink (buf, buf, sizeof (buf)) != -1 &&
                   ~~~  ^~~

This is pretty silly, but it seems simplest to just avoid passing the
same buffer to readlink as both pathname and buf.

index: explicitly follow GObject conventions

Use explicit labels for GTypeInfo member initializers, rather than
relying on comments and ordering.  This is both easier to read, and
harder to screw up.  This also makes it clear that we're mis-casting
GObject class initializers for gcc.

Without this patch, g++ 8.2.0-7 produces this warning:

CXX  -g -O2 lib/index.o
lib/index.cc: In function ‘GMimeFilter* notmuch_filter_discard_non_term_new(GMimeContentType*)’:
lib/index.cc:252:23: warning: cast between incompatible function types from ‘void (*)(NotmuchFilterDiscardNonTermClass*)’ {aka ‘void (*)(_NotmuchFilterDiscardNonTermClass*)’} to ‘GClassInitFunc’ {aka ‘void (*)(void*, void*)’} [-Wcast-function-type]
      (GClassInitFunc) notmuch_filter_discard_non_term_class_init,
                       ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The definition of GClassInitFunc in
/usr/include/glib-2.0/gobject/gtype.h suggests that this function will
always be called with the class_data member of the GTypeInfo.  We set
that value to NULL in both GObject definitions in notmuch. So we mark
it as explicitly unused.

There is no functional change here, just code cleanup.

Merge tag 'debian/0.28-2'

notmuch release 0.28-2 for unstable (sid) [dgit]
[dgit distro=debian]

debian: override location of bash

Yes, a build chroot can have /usr/bin/bash, thanks to usrmerge, but we
can't depend on it existing in the user's system.

version: bump to 0.28

debian: changelog stanza for 0.28-1

NEWS: NEWS for 0.28

This is based on my subjective assessment of what is user/packager
facing and important from the output of 'git shortlog'

emacs: Update integration with third party packages.

`mm-inline-text-html-with-images' was removed from mm-decode.el in
2016 and replaced with `mm-html-inhibit-images'.

`gnus-select-frame-set-input-focus' was removed from gnus-util.el in
2016 and existed only for XEmacs compatibility.

test: git should ignore message-id-parse

b31e44c678bf3bfe81bcc5f159e627551f12700f introduced message-id-parse
as a new binary created by the test suite.  It shows up as something
additional to git, but git ought to know to ignore it.

debian: changelog for 0.28~rc0-1

NEWS: start NEWS for 0.28

Just a stub for now.

version: bump to 0.28~rc0

debian: update zsh completion installation

This ${prefix}/share/vendor-completion convention seems to be debian
specific, so leave the global default alone for now.

completion: more complete completion for zsh.

This adds completion files for zsh that cover most of notmuch's cli.

The files in completion/zsh are formatted so that they can be found by
zsh's completion system if put $fpath. They are also registered to the
notmuch-* pattern, so they can be called externally using _dispatch.

Update installation recipe and drop debian/notmuch.examples to avoid
breakage. This means zsh completion is not installed for debian, to be
fixed in a future commit.

Amended by db: use regexp searching for address completion. This seems
to be fast enough to work without a cache.

emacs: Call `notmuch-mua-send-hook' hooks when sending a message

Previously any hook functions attached to `notmuch-mua-send-hook' were
ignored.

test: Check that `notmuch-mua-send-hook' is called on sending a message

python: fix unchecked None access in get_property

debian: update notmuch-mutt packaging to use install target

debian: bump compat level to 11

The immediate motivation is to have dh_installman look in debian/tmp

contrib/notmuch-mutt: add install target

The main goal here is to be able to install the notmuch-mutt script
with an absolute shebang. I have tried to make the notmuch-mutt
Makefile use configure information from notmuch if available, but make
suitable guesses if not.

configure: absolute path of perl

This can be used to set shebang lines during install.

build: install notmuch-emacs-mua with absolute shebang

Follow distro-centric rules to reduce the chance of surprising
behaviour due to PATH changes

configure: absolute path of bash

This can be used to set shebang lines during install.

test: make regexp test conditional on field processors

Normally we'd mark it broken, but perversely missing regexp support
actually makes the test pass.

test: mark thread subqueries broken without field processors

Currently these tests just fail when notmuch is built against Xapian
1.2.x

debian: add tar-ignore=.git

Unfortunately 514fb397c9 somewhat messed up the "debian-snapshot"
target, by including .git in the generated tarball.

Merge tag 'debian/0.27-3'

notmuch release 0.27-3 for unstable (sid) [dgit]
[dgit distro=debian]

debian: drop argument-less tar-ignore

This hangs up dgit. It's probably not useful for users of the source
package to have debian/.gitignore, but it should not hurt.

test: Absolute and relative directory paths.

notmuch: Database paths without a leading / are relative to $HOME

If the database path specified in the configuration file does *not*
start with a /, presume that it is relative to $HOME and modify the
path used to open the database accordingly.

Declare fast forward from 0.27-2

[dgit --overwrite]

debian: add unversioned emacs, drop emacs23

In current Debian sid / testing, emacs25 is a transitional package,
and emacs-gtk, emacs-lucid, and emacs-nox are the real packages.
Emacs 23 is not available in emacs after oldoldstable.

debian: update Vcs-Git URL

We should probably not git://, and it needs a branch to not confuse
e.g. vcswatch.

lib: change parent strategy to use In-Reply-To if it looks sane

As reported by Sean Whitton, there are mailers (in particular the
Debian Bug Tracking System) that have sensible In-Reply-To headers,
but un-useful-for-notmuch References (in particular with the BTS, the
oldest reference is last). I looked at a sample of about 200K
messages, and only about 0.5% these had something other than a single
message-id in In-Reply-To. On this basis, if we see a single
message-id in In-Reply-To, consider that as authoritative.

lib: add _notmuch_message_id_parse_strict

The idea is that if a message-id parses with this function, the MUA
generating it was probably sane, and in particular it's probably safe
to use the result as a parent from In-Reply-to.

util/string-util: export skip_space

It's only few lines, but we already define the function, so make it
usable elsewhere

test/thread-replies: mangle In-Reply-To's

In a future commit, we will start trusting In-Reply-To's when they
look sane (i.e. a single message-id). Modify these tests so they will
keep passing (i.e. keep choosing References) when that happens.

test: add known broken test for good In-Reply-To / bad References

The current scheme of choosing the replyto (i.e. the default parent
for threading purposes) does not work well for mailers that put
the oldest Reference last.

lib/thread: change _resolve_thread_relationships to use depths

We (finally) implement the XXX comment. It requires a bit of care not
to reparent all of the possible toplevel messages.

_notmuch_messages_has_next is not ready to be a public function yet,
since it punts on the mset case. We know in the one case it is called,
the notmuch_messages_t is just a regular list / iterator.

lib/thread: rewrite _parent_or_toplevel to use depths

This is part 1/2 of changing the reparenting of alleged toplevel
messages to use a "deep" reference rather than just the first one
found.

lib: calculate message depth in thread

This will be used in reparenting messages without useful in-reply-to,
but with useful references

lib/thread: initial use of references as for fallback parenting

This is mainly to lay out the structure of the final code. The problem
isn't really solved yet, although some very simple cases are
better (hence the fixed test). We need two passes through the messages
because we need to be careful not to re-parent too many messages and
end up without any toplevel messages.

use EMPTY_STRING in _parent_via_in_reply_to

This is a review suggestion [1] of Tomi. I decided not to squash it
so that the code movement remains clear.

[1]: id:m2pnxxgf5q.fsf@guru.guru-group.fi

lib/thread: refactor in_reply_to test

This is not a complete win in code-size, but it makes the code (which
is about to get more complicated) easier to follow.

lib: add _notmuch_message_list_empty

There is no public notmuch_message_list_t public interface, so to this
is added to the private API. We use it immediately in thread.cc;
future commits will use it further.

lib/thread: add macro for debug printing of threading

This is analogous to DEBUG_DATABASE_SANITY, and is intended to help
debugging and to help users submit bug reports.

lib: read reference terms into message struct.

The plan is to use these in resolving threads.

lib/thread: sort sibling messages by date

For non-root messages, this should not should anything currently, as
the messages are already added in date order. In the future we will
add some non-root messages in a second pass out of order and the
sorting will be useful. It does fix the order of multiple
root-messages (although it is overkill for that).

test: add known broken tests for "ghost roots"

This documents the bug discussed at

     id:87efgmmysi.fsf@len.workgroup

The underlying issue is that the reply to a ghost (missing) message is
falsely classified as a root message in _resolve_thread_relationships.

There are two pairs of tests; in each case the the first test is
simpler / more robust, but also easier to fool.

test: start threading test corpus

There are 3 threads here, two synthetic, and one anonymized one using
data from Gregor. They test various aspects of thread
ordering/construction in the presence of replies to ghost messages.

test/tag: add test for updating during batch tag operations

This clarifies that the breakage seen with Xapian 1.4.6 does not have
to do with "funny" tags.

This test is "known broken", but only with xapian 1.4.6, and there's
curently no convenient way to mark that.

lib: detect mislabeled Windows-1252 parts

Use GMime functionality to detect mislabeled messages and apply the
correct (Windows) encoding instead.

test: add known broken test for mislabeled Windows-1252 encoding

Messages that contain Windows-1252 are frequently mislabeled as ISO
8859-1, which may result in non-printable characters when displaying
the message. The test asserts that such characters (in this case
curved quotes) are displayed correctly.

emacs: Kill the stderr buffer when an async process completes

On some platforms (e.g. macOS), it is necessary to add a real sentinel
process for the error buffer used by `notmuch-start-notmuch' rather
than a no-op sentinel.

debian: changelog for 0.27-2

notmuch (0.27-2) unstable; urgency=medium

  * Add texinfo as a build-dep, build info version of documentation.

[dgit import unpatched notmuch 0.27-2]

Import notmuch_0.27-2.debian.tar.xz

[dgit import tarball notmuch 0.27-2 notmuch_0.27-2.debian.tar.xz]

debian: add build depency on texinfo

This is needed to provide a makeinfo binary, to build the info version
of the documentation.

doc: clean up manpages

Many of the manpages didn't treat literal text as literal text.  I've
tried to normalize some of the restructured text to make it a bit more
regular.

several of the synopsis lines are still untouched by this cleanup, but
i'm not sure what the right way to represent those is in .rst,
actually.

In particular find that if i rebuild the manpages, sometimes i end up
with some of the synopsis lines showing – (U+2013 EN DASH) where they
should have -- (2 × U+002D HYPHEN-MINUS) in the generated nroff
output, though i have not tracked down the source of this error yet.

use #!/usr/bin/env python consistently

minor cleanup to printmimestructure

make the source slightly easier to read.  no functional change.

devel: make printmimestructure py3 compatible

Make printmimestructure work in python3 as well as python2.

minor post-0.26 NEWS layout fixes

As usual, one notices these *after* release(s).

Merge tag '0.27'

notmuch 0.27 release

NEWS: set date

debian: changelog for 0.27-1

Import notmuch_0.27.orig.tar.gz

[dgit import orig notmuch_0.27.orig.tar.gz]

version: bump to 0.27

doc: document notmuch show --decrypt=stash

Help users find this new indexed-cleartext workflow.

Merge tag '0.27_rc1'

notmuch 0.27~rc1 release

debian: changelog stanza for 0.27~rc1-1

version: bump to 0.27~rc1

configure: check for links to/from libdir in ldconfig output

If e.g. /lib is a link to /usr/lib, then the latter may not show up in
the way we expect in the output of ldconfig. 'test foo -ef bar' checks
if foo and bar have the same device and inode numbers. Since (at least
in bash, dash, ksh, and zsh) the shell dereferences symlinks before
applying the test, this includes both the case where file1 is equal to
file2 and the case where one is a symlink to the other.

NEWS: document installation of notmuch-emacs manual

NEWS: mention notmuch --full-scan

NEWS: mention thread:{} queries

NEWS: deprecate pre-1.4.0 Xapian

We want to give people some heads up before dropping support, since
removing a bunch of ifdefs will be a pain to revert.

debian: update symbols for 0.27

add two new API symbols

NEWS: start entry for 0.27

No content yet.

test: fix hardcoded paths in T050-new.sh

The previous paths will fail almost everywhere.

debian: changelog for 0.27~rc0-1

bump version to 0.27~rc0

Start the busywork for a new release

docs: add initial documentation for notmuch-tag-jump

This is mainly to improve discoverability. It seems that doing
variable cross-references is not easy without using some sphinx
extension/customization.

doc: initial documentation for notmuch-tree mode

doc: initial documentation for notmuch-show-mode

This is pretty minimal, but will hopefully inspire others to
contribute more complete documentation. If nothing else, it points out
'?'.

debian: install info pages as part of elpa (emacs) package

This is a simple way to make the info pages available, since the emacs
package system deals with the annoying bits.  If there is many people
who want the info pages outside of emacs, we could consider a separate
binary package, but currently it doesn't seem worthwhile.