summaryrefslogtreecommitdiffstats
path: root/doc/man1
diff options
context:
space:
mode:
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>2017-10-20 22:25:42 -0400
committerDavid Bremner <david@tethera.net>2017-10-21 19:54:24 -0300
commit886c0b1666478548485682fbcaa667bb3cc0f138 (patch)
tree86a932b1b0091a392595d381a2fdc6229e58fd93 /doc/man1
parent4dfcc8c9b2e1dbb965f69283dca50c7581c88050 (diff)
config: test whether an item is stored in the database by name
QUERY_STRING was only used in two places, both to test whether a variable should be stored in (or retrieved from) the database. Since other configuration variables might be stored in the database in the future, consolidate that test into a single function. We also document that these configuration options should not be placed in the config file.
Diffstat (limited to 'doc/man1')
-rw-r--r--doc/man1/notmuch-config.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 71294554..539199c2 100644
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -15,7 +15,11 @@ DESCRIPTION
===========
The **config** command can be used to get or set settings in the notmuch
-configuration file.
+configuration file and corresponding database.
+
+Items marked **[STORED IN DATABASE]** are only in the database. They
+should not be placed in the configuration file, and should be accessed
+programmatically as described in the SYNOPSIS above.
**get**
The value of the specified configuration item is printed to
@@ -142,6 +146,7 @@ The available configuration items are described below.
**query.<name>**
+ **[STORED IN DATABASE]**
Expansion for named query called <name>. See
**notmuch-search-terms(7)** for more information about named
queries.