From: David Bremner <david@tethera.net>
Date: Fri, 7 May 2021 11:13:22 +0000 (-0300)
Subject: doc: document database.backup_dir
X-Git-Tag: archive/debian/0.32.1-1~12
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=bfbe2e55f294532c67ef3b10fca1996a33fccd32

doc: document database.backup_dir

Most users will not need to change this, but documenting it helps
preserve the interface.
---

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index b158dac3..75c59ff9 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -65,6 +65,14 @@ paths are presumed relative to `$HOME` for items in section
     Default: For compatibility with older configurations, the value of
     database.path is used if **database.mail\_root** is unset.
 
+**database.backup_dir**
+    Directory to store tag dumps when upgrading database.
+
+    History: this configuration value was introduced in notmuch 0.32.
+
+    Default: A sibling directory of the Xapian database called
+    `backups`.
+
 **database.hook_dir**
 
     Directory containing hooks run by notmuch commands. See