debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-12-22 01:14:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

CLI: update commentary in config file to better match code

Browse source 
This comment has been out of date since notmuch 0.32. Although it
isn't really possible to explain all the options here, explain both
one new "split" way of doing things and the traditional one with
database inside $MAIL_ROOT/.notmuch.
This commit is contained in:
David Bremner 2023-09-21 16:50:02 -03:00
parent a1921a25b7
commit 14150416dd
2 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
notmuch-config.c
View file

@ -40,11 +40,13 @@ static const struct config_group {
"database", "database",
" Database configuration\n" " Database configuration\n"
"\n" "\n"
" The only value supported here is 'path' which should be the top-level\n" " Supported values are 'mail_root' and 'path'. The recommended option\n"
" directory where your mail currently exists and to where mail will be\n" " is to set 'mail_root' to the directory where your mail currently exists\n"
" delivered in the future. Files should be individual email messages.\n" " and to where mail will be delivered in the future. Files should be\n"
" Notmuch will store its database within a sub-directory of the path\n" " individual email messages. By default notmuch will store its database\n"
" configured here named \".notmuch\".\n" " in $XDG_DATA_HOME/notmuch; you can override this by setting 'path'.\n"
" If only 'path' is set, this directory is for 'mail_root' and for\n"
" the database location (in a subdirectory called \".notmuch\").\n"
}, },
{ {
"user", "user",

12
test/setup.expected-output/config-with-comments
View file

@ -3,11 +3,13 @@
# For more information about notmuch, see https://notmuchmail.org # For more information about notmuch, see https://notmuchmail.org
# Database configuration # Database configuration
# #
# The only value supported here is 'path' which should be the top-level # Supported values are 'mail_root' and 'path'. The recommended option
# directory where your mail currently exists and to where mail will be # is to set 'mail_root' to the directory where your mail currently exists
# delivered in the future. Files should be individual email messages. # and to where mail will be delivered in the future. Files should be
# Notmuch will store its database within a sub-directory of the path # individual email messages. By default notmuch will store its database
# configured here named ".notmuch". # in $XDG_DATA_HOME/notmuch; you can override this by setting 'path'.
# If only 'path' is set, this directory is for 'mail_root' and for
# the database location (in a subdirectory called ".notmuch").
# #
[database] [database]
path=/path/to/maildir path=/path/to/maildir