diff options
| author | David Bremner <david@tethera.net> | 2021-02-19 08:41:36 -0400 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2021-03-27 09:26:14 -0300 |
| commit | dd9112e7d8e89e8566b90379f5f3b1461a2d2845 (patch) | |
| tree | 0dc50fd5aeb6205ca3bbaa99035f5313be7f3b9d /doc/man1 | |
| parent | 7f6aae4f64add17d9750d2d8491930e15fad4fe1 (diff) | |
CLI/config: default to storing all config in external files
Previously the fact that some configuration options were only stored
in the database (and thus editing the config file had no effect) was a
source of user confusion. This was fixed with the series ending at
d9af0af1646.
On the other hand, the underlying partition of config options into
those stored by default in the database and those stored in the config
file remained. This is also confusing, since now some invocations of
"notmuch config set" modify the config file, and others silently
modify the database instead.
With this commit, it is up to the user to decide which configuration
to modify. A new "--database" option is provided for notmuch config to
enable modifying the configuration information in the database;
otherwise the default is to update an external config file.
Diffstat (limited to 'doc/man1')
| -rw-r--r-- | doc/man1/notmuch-config.rst | 6 | ||||
| -rw-r--r-- | doc/man1/notmuch.rst | 4 |
2 files changed, 8 insertions, 2 deletions
diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 223d2de5..32290a38 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -7,7 +7,7 @@ SYNOPSIS **notmuch** **config** **get** <*section*>.<*item*> -**notmuch** **config** **set** <*section*>.<*item*> [*value* ...] +**notmuch** **config** **set** [--database] <*section*>.<*item*> [*value* ...] **notmuch** **config** **list** @@ -30,6 +30,10 @@ configuration file and corresponding database. If no values are provided, the specified configuration item will be removed from the configuration file. + With the `--database` option, updates configuration metadata + stored in the database, rather than the default (text) + configuration file. + **list** Every configuration item is printed to stdout, each on a separate line of the form:: diff --git a/doc/man1/notmuch.rst b/doc/man1/notmuch.rst index fecfd08a..48351588 100644 --- a/doc/man1/notmuch.rst +++ b/doc/man1/notmuch.rst @@ -48,7 +48,9 @@ Supported global options for ``notmuch`` include ``--config=FILE`` Specify the configuration file to use. This overrides any - configuration file specified by ${NOTMUCH\_CONFIG}. + configuration file specified by ${NOTMUCH\_CONFIG}. The empty + string is a permitted and sometimes useful value of *FILE*, which + tells ``notmuch`` to use only configuration metadata from the database. ``--uuid=HEX`` Enforce that the database UUID (a unique identifier which persists |