unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 7/7] doc: document user header indexing.
Date: Sat,  2 Mar 2019 11:41:33 -0400	[thread overview]
Message-ID: <20190302154133.25642-8-david@tethera.net> (raw)
In-Reply-To: <20190302154133.25642-1-david@tethera.net>

It's a bit odd that the primary documentation is in notmuch-config,
but it is consistent with the "query:" prefix.
---
 doc/man1/notmuch-config.rst       | 8 ++++++++
 doc/man7/notmuch-search-terms.rst | 3 +++
 2 files changed, 11 insertions(+)

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 89909808..b91cbfd3 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -195,6 +195,14 @@ The available configuration items are described below.
 
     Default: ``auto``.
 
+**index.header.<prefix>** **[STORED IN DATABASE]**
+    Define the query prefix <prefix>, based on a mail header. For
+    example ``index.header.list=List-Id`` will add a probabilistic
+    prefix ``list:`` that searches the ``List-Id`` field. Adding a
+    prefix with same name as a predefined prefix is not supported. See
+    **notmuch-search-terms(7)** for a list of existing prefixes, and
+    an explanation of probabilistic prefixes.
+
 **built_with.<name>**
     Compile time feature <name>. Current possibilities include
     "compact" (see **notmuch-compact(1)**) and "field_processor" (see
diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst
index f7a39ceb..36ba804b 100644
--- a/doc/man7/notmuch-search-terms.rst
+++ b/doc/man7/notmuch-search-terms.rst
@@ -166,6 +166,9 @@ property:<key>=<value>
     can be present on a given message with several different values.
     See **notmuch-properties(7)** for more details.
 
+User defined prefixes are also supported, see **notmuch-config(1)** for
+details.
+
 Operators
 ---------
 
-- 
2.20.1

  parent reply	other threads:[~2019-03-02 15:41 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-02 15:41 WIP2: index user headers David Bremner
2019-03-02 15:41 ` [PATCH 1/7] cli/config: refactor _stored_in_db David Bremner
2019-03-02 15:41 ` [PATCH 2/7] cli/config: support user header index config David Bremner
2019-03-02 15:41 ` [PATCH 3/7] lib: setup user headers in query parser David Bremner
2019-03-02 15:41 ` [PATCH 4/7] lib: cache user prefixes in database object David Bremner
2019-03-02 15:41 ` [PATCH 5/7] lib: support user prefix names in term generation David Bremner
2019-03-02 15:41 ` [PATCH 6/7] lib/database: index user headers David Bremner
2019-03-02 15:41 ` David Bremner [this message]
2019-03-02 15:43 ` WIP2: " David Bremner
2019-03-03 14:56 ` David Bremner
2019-03-04  1:54   ` David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190302154133.25642-8-david@tethera.net \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).