about summary refs log tree commit homepage
path: root/script
diff options
context:
space:
mode:
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 /script
parent28264f7af4d9f4fab951f0613a0b08b6e98af7d3 (diff)
downloadpublic-inbox-3c39f9c942a6975245fda878e9b957d8d3367662.tar.gz
"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 'script')
-rwxr-xr-xscript/public-inbox-convert16
-rwxr-xr-xscript/public-inbox-edit2
-rwxr-xr-xscript/public-inbox-init16
-rwxr-xr-xscript/public-inbox-mda2
4 files changed, 18 insertions, 18 deletions
diff --git a/script/public-inbox-convert b/script/public-inbox-convert
index 9d2d2512..3182410e 100755
--- a/script/public-inbox-convert
+++ b/script/public-inbox-convert
@@ -30,14 +30,14 @@ $old_dir = abs_path($old_dir);
 my $old;
 if ($config) {
         $config->each_inbox(sub {
-                $old = $_[0] if abs_path($_[0]->{mainrepo}) eq $old_dir;
+                $old = $_[0] if abs_path($_[0]->{inboxdir}) eq $old_dir;
         });
 }
 unless ($old) {
         warn "W: $old_dir not configured in " .
                 PublicInbox::Config::default_file() . "\n";
         $old = {
-                mainrepo => $old_dir,
+                inboxdir => $old_dir,
                 name => 'ignored',
                 address => [ 'old@example.com' ],
         };
@@ -48,7 +48,7 @@ if (($old->{version} || 1) >= 2) {
         die "Only conversion from v1 inboxes is supported\n";
 }
 my $new = { %$old };
-$new->{mainrepo} = abs_path($new_dir);
+$new->{inboxdir} = abs_path($new_dir);
 $new->{version} = 2;
 $new = PublicInbox::InboxWritable->new($new);
 my $v2w;
@@ -62,9 +62,9 @@ sub link_or_copy ($$) {
 }
 
 $old->with_umask(sub {
-        my $old_cfg = "$old->{mainrepo}/config";
+        my $old_cfg = "$old->{inboxdir}/config";
         local $ENV{GIT_CONFIG} = $old_cfg;
-        my $new_cfg = "$new->{mainrepo}/all.git/config";
+        my $new_cfg = "$new->{inboxdir}/all.git/config";
         $v2w = PublicInbox::V2Writable->new($new, 1);
         $v2w->init_inbox($jobs);
         unlink $new_cfg;
@@ -79,9 +79,9 @@ $old->with_umask(sub {
                         $src->mm_alt->{dbh}->sqlite_backup_to_file($dst);
                 }
         }
-        my $desc = "$old->{mainrepo}/description";
-        link_or_copy($desc, "$new->{mainrepo}/description") if -e $desc;
-        my $clone = "$old->{mainrepo}/cloneurl";
+        my $desc = "$old->{inboxdir}/description";
+        link_or_copy($desc, "$new->{inboxdir}/description") if -e $desc;
+        my $clone = "$old->{inboxdir}/cloneurl";
         if (-e $clone) {
                 warn <<"";
 $clone may not be valid after migrating to v2, not copying
diff --git a/script/public-inbox-edit b/script/public-inbox-edit
index 6884fd0c..f2090abf 100755
--- a/script/public-inbox-edit
+++ b/script/public-inbox-edit
@@ -65,7 +65,7 @@ sub find_mid ($) {
 
 sub show_cmd ($$) {
         my ($ibx, $smsg) = @_;
-        " GIT_DIR=$ibx->{mainrepo}/all.git \\\n    git show $smsg->{blob}\n";
+        " GIT_DIR=$ibx->{inboxdir}/all.git \\\n    git show $smsg->{blob}\n";
 }
 
 sub show_found () {
diff --git a/script/public-inbox-init b/script/public-inbox-init
index 8fd2f9dc..50711266 100755
--- a/script/public-inbox-init
+++ b/script/public-inbox-init
@@ -31,7 +31,7 @@ my %opts = (
 GetOptions(%opts) or usage();
 PublicInbox::Admin::indexlevel_ok_or_die($indexlevel) if defined $indexlevel;
 my $name = shift @ARGV or usage();
-my $mainrepo = shift @ARGV or usage();
+my $inboxdir = shift @ARGV or usage();
 my $http_url = shift @ARGV or usage();
 my (@address) = @ARGV;
 @address or usage();
@@ -112,18 +112,18 @@ close $fh or die "failed to close $pi_config_tmp: $!\n";
 my $pfx = "publicinbox.$name";
 my @x = (qw/git config/, "--file=$pi_config_tmp");
 
-$mainrepo = abs_path($mainrepo);
-if (-f "$mainrepo/inbox.lock") {
+$inboxdir = abs_path($inboxdir);
+if (-f "$inboxdir/inbox.lock") {
         if (!defined $version) {
                 $version = 2;
         } elsif ($version != 2) {
-                die "$mainrepo is a -V2 repo, -V$version specified\n"
+                die "$inboxdir is a -V2 repo, -V$version specified\n"
         }
-} elsif (-d "$mainrepo/objects") {
+} elsif (-d "$inboxdir/objects") {
         if (!defined $version) {
                 $version = 1;
         } elsif ($version != 1) {
-                die "$mainrepo is a -V1 repo, -V$version specified\n"
+                die "$inboxdir is a -V1 repo, -V$version specified\n"
         }
 }
 
@@ -134,7 +134,7 @@ if ($version == 1 && defined $skip_epoch) {
 }
 
 my $ibx = PublicInbox::Inbox->new({
-        mainrepo => $mainrepo,
+        inboxdir => $inboxdir,
         name => $name,
         version => $version,
         -primary_address => $address[0],
@@ -152,7 +152,7 @@ foreach my $addr (@address) {
         x(@x, "--add", "$pfx.address", $addr);
 }
 x(@x, "$pfx.url", $http_url);
-x(@x, "$pfx.mainrepo", $mainrepo);
+x(@x, "$pfx.inboxdir", $inboxdir);
 
 if (defined($indexlevel)) {
         x(@x, "$pfx.indexlevel", $indexlevel);
diff --git a/script/public-inbox-mda b/script/public-inbox-mda
index 2655a6c5..dea49dc5 100755
--- a/script/public-inbox-mda
+++ b/script/public-inbox-mda
@@ -51,7 +51,7 @@ if (!defined $dst) {
         }
         defined $dst or do_exit(67); # EX_NOUSER 5.1.1 user unknown
 }
-$dst->{mainrepo} or do_exit(67);
+$dst->{inboxdir} or do_exit(67);
 $dst = PublicInbox::InboxWritable->new($dst);
 
 # pre-check, MDA has stricter rules than an importer might;