From a7117efb3725e6197dd95424136f79147aa35e5b Mon Sep 17 00:00:00 2001
From: Jdogzz <jerzor@pacbell.net>
Date: Tue, 4 Jun 2024 11:23:39 -0700
Subject: [PATCH] accounts.email: add clarifying documentation
Add clarifying documentation for maildirBasePath value. Also improve
default text.
---
modules/accounts/email.nix | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/modules/accounts/email.nix b/modules/accounts/email.nix
index 8657c4cbd..f3996195d 100644
--- a/modules/accounts/email.nix
+++ b/modules/accounts/email.nix
@@ -493,13 +493,14 @@ in {
maildirBasePath = mkOption {
type = types.str;
default = "${config.home.homeDirectory}/Maildir";
- defaultText = "$HOME/Maildir";
+ defaultText = "Maildir";
apply = p:
if hasPrefix "/" p then p else "${config.home.homeDirectory}/${p}";
description = ''
The base directory for account maildir directories. May be a
- relative path, in which case it is relative the home
- directory.
+ relative path (e.g. the user setting this value as "MyMaildir"),
+ in which case it is relative the home directory (e.g. resulting
+ in "~/MyMaildir").
'';
};