unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH] doc: document index.check_mbox option.
Date: Sun,  6 Feb 2022 15:42:35 -0400	[thread overview]
Message-ID: <20220206194235.419133-1-david@tethera.net> (raw)
In-Reply-To: <20220205195215.166213-7-david@tethera.net>

---
This needs to be applied on top of the series id:20220206142334.303341-1-david@tethera.net


 doc/man1/notmuch-config.rst | 10 ++++++++++
 doc/man1/notmuch-insert.rst |  1 +
 doc/man1/notmuch-new.rst    |  1 +
 3 files changed, 12 insertions(+)

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index acc5ecec..f24c58a5 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -159,6 +159,16 @@ index.decrypt
 
     Default: ``auto``.
 
+.. _index.check_mbox:
+
+index.check\_mbox
+    Avoid indexing files which appear to be :manpage:`mbox` files with
+    more than one message.
+
+    Default: ``true``.
+
+    History: This configuration value was introduced in notmuch 0.36.
+
 .. _index.header:
 
 index.header.<prefix>
diff --git a/doc/man1/notmuch-insert.rst b/doc/man1/notmuch-insert.rst
index fe2bf26b..ed29e77f 100644
--- a/doc/man1/notmuch-insert.rst
+++ b/doc/man1/notmuch-insert.rst
@@ -92,6 +92,7 @@ CONFIGURATION
 =============
 
 Indexing is influenced by the configuration options
+:ref:`index.check_mbox <index.check_mbox>`,
 :ref:`index.decrypt <index.decrypt>` and :ref:`index.header
 <index.header>`.  Tagging
 is controlled by :ref:`new.tags <new.tags>` and
diff --git a/doc/man1/notmuch-new.rst b/doc/man1/notmuch-new.rst
index 398f8813..0b871c56 100644
--- a/doc/man1/notmuch-new.rst
+++ b/doc/man1/notmuch-new.rst
@@ -82,6 +82,7 @@ CONFIGURATION
 =============
 
 Indexing is influenced by the configuration options
+:ref:`index.check_mbox <index.check_mbox>`,
 :ref:`index.decrypt <index.decrypt>`, :ref:`index.header
 <index.header>`, and :ref:`new.ignore <new.ignore>`.  Tagging
 is controlled by :ref:`new.tags <new.tags>` and
-- 
2.34.1

  reply	other threads:[~2022-02-06 19:42 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-05 19:52 allow disabling the check for multi-message mboxes David Bremner
2022-02-05 19:52 ` [PATCH 1/6] test: start new corpus of test messages for indexing code David Bremner
2022-02-05 19:52 ` [PATCH 2/6] test: add known broken test for non-email false positive David Bremner
2022-02-05 19:52 ` [PATCH 3/6] lib/config: add configuration item for controlling check for mbox David Bremner
2022-02-05 19:52 ` [PATCH 4/6] test: add known broken test for index.check_mbox=false David Bremner
2022-02-05 19:52 ` [PATCH 5/6] lib/message-file: stash pointer to "parent" notmuch database David Bremner
2022-02-05 19:52 ` [PATCH 6/6] lib/message-file: allow disabling check for mbox files David Bremner
2022-02-06 19:42   ` David Bremner [this message]
2022-02-08 20:58 ` allow disabling the check for multi-message mboxes David Bremner
2022-02-20 13:23 ` 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=20220206194235.419133-1-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).