[PATCH] doc: document index.check_mbox option.

Subject:[PATCH] doc: document index.check_mbox option.

Date:Sun, 6 Feb 2022 15:42:35 -0400

To:David Bremner ,notmuch@notmuchmail.org

Cc:

From:David Bremner


---
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

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: