From 3c39f9c942a6975245fda878e9b957d8d3367662 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Wed, 16 Oct 2019 08:59:55 +0000 Subject: config: support "inboxdir" in addition to "mainrepo" "mainrepo" ws a bad name and artifact from the early days when I intended for there to be a "spamrepo" (now just the ENV{PI_EMERGENCY} Maildir). With v2, "mainrepo" can be especially confusing, since v2 needs at least two git repositories (epoch + all.git) to function and we shouldn't confuse users by having them point to a git repository for v2. Much of our documentation already references "INBOX_DIR" for command-line arguments, so use "inboxdir" as the git-config(1)-friendly variant for that. "mainrepo" remains supported indefinitely for compatibility. Users may need to revert to old versions, or may be referring to old documentation and must not be forced to change config files to account for this change. So if you're using "mainrepo" today, I do NOT recommend changing it right away because other bugs can lurk. Link: https://public-inbox.org/meta/874l0ice8v.fsf@alyssa.is/ --- Documentation/public-inbox-config.pod | 19 +++++++++++++------ Documentation/public-inbox-convert.pod | 2 +- Documentation/public-inbox-init.pod | 2 +- Documentation/public-inbox-watch.pod | 4 ++-- 4 files changed, 17 insertions(+), 10 deletions(-) (limited to 'Documentation') diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 6a9739f7..1c5ba015 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -17,13 +17,17 @@ all public-inboxes used by a particular user. =head2 EXAMPLE [publicinbox "test"] - mainrepo = /home/user/path/to/test.git + inboxdir = /home/user/path/to/test.git ; multiple addresses are supported address = test@example.com ; address = alternate@example.com url = http://example.com/test newsgroup = inbox.test + ; backwards compatibility with public-inbox pre-1.2.0, + ; "inboxdir" takes precedence over "mainrepo" + mainrepo = /home/user/path/to/test.git + =head2 VARIABLES =over 8 @@ -38,11 +42,14 @@ informational purposes. Default: none, required -=item publicinbox..mainrepo +=item publicinbox..inboxdir The absolute path to the directory which hosts the public-inbox. This must be specified once. +This was previously known as "mainrepo", which remains supported, +but "inboxdir" takes precedence. + Default: none, required =item publicinbox..url @@ -373,20 +380,20 @@ RLIMIT_CPU, and RLIMIT_DATA for you operating system. ; big inboxes which require lots of memory to clone: [publicinbox "big1"] - mainrepo = /path/to/big1 + inboxdir = /path/to/big1 address = big1@example.com httpbackendmax = big [publicinbox "big2"] - mainrepo = /path/to/big2 + inboxdir = /path/to/big2 address = big2@example.com httpbackendmax = big ; tiny inboxes which are easily cloned: [publicinbox "tiny1"] - mainrepo = /path/to/tiny1 + inboxdir = /path/to/tiny1 address = tiny1@example.com [publicinbox "tiny2"] - mainrepo = /path/to/tiny2 + inboxdir = /path/to/tiny2 address = tiny2@example.com [publicinboxlimiter "big"] diff --git a/Documentation/public-inbox-convert.pod b/Documentation/public-inbox-convert.pod index 4e358c9d..4c790dee 100644 --- a/Documentation/public-inbox-convert.pod +++ b/Documentation/public-inbox-convert.pod @@ -10,7 +10,7 @@ public-inbox-convert - convert v1 inboxes to v2 public-inbox-convert copies the contents of an old "v1" inbox into a new "v2" inbox. It makes no changes to the old inbox -and users are expected to update the "mainrepo" path in +and users are expected to update the "inboxdir" path in L to point to the path of NEW_DIR once they are satisfied with the conversion. diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod index 377fb2a2..f5de6bf9 100644 --- a/Documentation/public-inbox-init.pod +++ b/Documentation/public-inbox-init.pod @@ -11,7 +11,7 @@ B [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..] Creates an empty public-inbox or reinitializes an existing one. It updates C<~/.public-inbox/config> by creating a C<[publicinbox "NAME"]> section where -C is C, +C is C, C is C, and C is C
. Multiple addresses may be specified for inboxes with multiple addresses. diff --git a/Documentation/public-inbox-watch.pod b/Documentation/public-inbox-watch.pod index 198c170a..0934eade 100644 --- a/Documentation/public-inbox-watch.pod +++ b/Documentation/public-inbox-watch.pod @@ -12,7 +12,7 @@ In ~/.public-inbox/config: ; generic public-inbox-config keys: address = test@example.com url = http://example.com/test - mainrepo = /path/to/test.example.com.git + inboxdir = /path/to/test.example.com.git ; config keys specific to public-inbox-watch: @@ -28,7 +28,7 @@ In ~/.public-inbox/config: ; optional, emails marked as read which appear ; here will be trained as spam and deleted from - ; the mainrepos of any public-inboxes which are + ; the inboxdirs of any public-inboxes which are ; configured for watch. ; This is global for all publicinbox.* sections watchspam = maildir:/path/to/maildirs/.INBOX.spam -- cgit v1.2.3-24-ge0c7