about summary refs log tree commit homepage
path: root/Documentation/public-inbox-init.pod
diff options
authorEric Wong <e@80x24.org>2019-10-16 08:59:55 +0000
committerEric Wong <e@80x24.org>2019-10-16 09:00:26 +0000
commit3c39f9c942a6975245fda878e9b957d8d3367662 (patch)
tree10c2ea542787ff08dae59ddd3f13f129ed63dd76 /Documentation/public-inbox-init.pod
parent28264f7af4d9f4fab951f0613a0b08b6e98af7d3 (diff)
"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/
Diffstat (limited to 'Documentation/public-inbox-init.pod')
1 files changed, 1 insertions, 1 deletions
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<public-inbox-init> [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<publicinbox.NAME.mainrepo> is C<INBOX_DIR>,
+C<publicinbox.NAME.inboxdir> is C<INBOX_DIR>,
 C<publicinbox.NAME.url> is C<HTTP_URL>, and
 C<publicinbox.NAME.address> is C<ADDRESS>.  Multiple addresses
 may be specified for inboxes with multiple addresses.