]> git.cworth.org Git - notmuch/commitdiff
doc: document database.backup_dir
authorDavid Bremner <david@tethera.net>
Fri, 7 May 2021 11:13:22 +0000 (08:13 -0300)
committerDavid Bremner <david@tethera.net>
Mon, 10 May 2021 14:14:57 +0000 (11:14 -0300)
Most users will not need to change this, but documenting it helps
preserve the interface.

doc/man1/notmuch-config.rst

index b158dac3c85884dd5cbdc310edac449e72654bc0..75c59ff971880b198ab4aff499ed4c983d11860c 100644 (file)
@@ -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