unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Cc: felix.lechner@lease-up.com
Subject: [PATCH] CLI: update commentary in config file to better match code
Date: Thu, 21 Sep 2023 16:50:02 -0300	[thread overview]
Message-ID: <20230921195002.807669-1-david@tethera.net> (raw)

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.
---
 notmuch-config.c                                | 12 +++++++-----
 test/setup.expected-output/config-with-comments | 12 +++++++-----
 2 files changed, 14 insertions(+), 10 deletions(-)

diff --git a/notmuch-config.c b/notmuch-config.c
index 8123e438..f7e59f1e 100644
--- a/notmuch-config.c
+++ b/notmuch-config.c
@@ -40,11 +40,13 @@ static const struct config_group {
 	"database",
 	" Database configuration\n"
 	"\n"
-	" The only value supported here is 'path' which should be the top-level\n"
-	" directory where your mail currently exists and to where mail will be\n"
-	" delivered in the future. Files should be individual email messages.\n"
-	" Notmuch will store its database within a sub-directory of the path\n"
-	" configured here named \".notmuch\".\n"
+	" Supported values are 'mail_root' and 'path'. The recommended option\n"
+	" is to set 'mail_root' to the directory where your mail currently exists\n"
+	" and to where mail will be delivered in the future. Files should be\n"
+	" individual email messages. By default notmuch will store its database\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",
diff --git a/test/setup.expected-output/config-with-comments b/test/setup.expected-output/config-with-comments
index d925acea..5d96be7f 100644
--- a/test/setup.expected-output/config-with-comments
+++ b/test/setup.expected-output/config-with-comments
@@ -3,11 +3,13 @@
 # For more information about notmuch, see https://notmuchmail.org
 # Database configuration
 #
-# The only value supported here is 'path' which should be the top-level
-# directory where your mail currently exists and to where mail will be
-# delivered in the future. Files should be individual email messages.
-# Notmuch will store its database within a sub-directory of the path
-# configured here named ".notmuch".
+# Supported values are 'mail_root' and 'path'. The recommended option
+# is to set 'mail_root' to the directory where your mail currently exists
+# and to where mail will be delivered in the future. Files should be
+# individual email messages. By default notmuch will store its database
+# 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]
 path=/path/to/maildir
-- 
2.40.1

                 reply	other threads:[~2023-09-21 19:50 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230921195002.807669-1-david@tethera.net \
    --to=david@tethera.net \
    --cc=felix.lechner@lease-up.com \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).