Merge remote-tracking branch 'origin/inboxdir'

* origin/inboxdir:
  config: remove redundant inboxdir check
  config: support "inboxdir" in addition to "mainrepo"
  examples/grok-pull.post_update_hook: use "inbox_dir"

4 files changed, 17 insertions, 10 deletions

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.<name>.mainrepo
+=item publicinbox.<name>.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.<name>.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<public-inbox-config(5)> 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<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.
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