about summary refs log tree commit homepage
path: root/script
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-08-10 02:12:00 +0000
committerEric Wong <e@yhbt.net>2020-08-10 06:26:21 +0000
commit6a7e3c6f870d0555184b68940eb373fa102d4102 (patch)
treea0b696867ad31baba92ad4af64b76ae5aec031ea /script
parent5fdedf809e7f236c7e50177bff8426a9befbcceb (diff)
downloadpublic-inbox-6a7e3c6f870d0555184b68940eb373fa102d4102.tar.gz
Move away from hard-to-read alllowercase naming and favor
snake_case or separated-by-dashes.

We'll keep `--indexlevel' as-is for now, since it's been around
for several releases; but we'll support `--index-level' in the
CLI and update our documentation in a few months.

We'll also clarify that publicInbox.indexMaxSize is only
intended for -index, and not -watch or -mda.
Diffstat (limited to 'script')
-rwxr-xr-xscript/public-inbox-index35
-rwxr-xr-xscript/public-inbox-init8
2 files changed, 19 insertions, 24 deletions
diff --git a/script/public-inbox-index b/script/public-inbox-index
index 9e0907be..b1d29ec1 100755
--- a/script/public-inbox-index
+++ b/script/public-inbox-index
@@ -17,7 +17,7 @@ usage: $usage
 options:
 
   --no-fsync          speed up indexing, risk corruption on power outage
-  --indexlevel=LEVEL  `basic', 'medium', or `full' (default: full)
+  -L LEVEL            `basic', `medium', or `full' (default: full)
   --compact | -c      run public-inbox-compact(1) after indexing
   --sequential-shard  index Xapian shards sequentially for slow storage
   --jobs=NUM          set or disable parallelization (NUM=0)
@@ -33,16 +33,17 @@ BYTES may use `k', `m', and `g' suffixes (e.g. `10m' for 10 megabytes)
 See public-inbox-index(1) man page for full documentation.
 EOF
 my $compact_opt;
-my $opt = { quiet => -1, compact => 0, maxsize => undef, fsync => 1 };
+my $opt = { quiet => -1, compact => 0, max_size => undef, fsync => 1 };
 GetOptions($opt, qw(verbose|v+ reindex rethread compact|c+ jobs|j=i prune
-                fsync|sync! xapianonly|xapian-only
-                indexlevel|L=s maxsize|max-size=s batchsize|batch-size=s
-                sequentialshard|seq-shard|sequential-shard
+                fsync|sync! xapian_only|xapian-only
+                indexlevel|index-level|L=s max_size|max-size=s
+                batch_size|batch-size=s
+                sequential_shard|seq-shard|sequential-shard
                 help|?))
         or die "bad command-line args\n$usage";
 if ($opt->{help}) { print $help; exit 0 };
 die "--jobs must be >= 0\n" if defined $opt->{jobs} && $opt->{jobs} < 0;
-if ($opt->{xapianonly} && !$opt->{reindex}) {
+if ($opt->{xapian_only} && !$opt->{reindex}) {
         die "--xapian-only requires --reindex\n";
 }
 
@@ -64,40 +65,38 @@ my @ibxs = PublicInbox::Admin::resolve_inboxes(\@ARGV, undef, $cfg);
 PublicInbox::Admin::require_or_die('-index');
 unless (@ibxs) { print STDERR "Usage: $usage\n"; exit 1 }
 
-my $max_size = $opt->{maxsize} // $cfg->{lc('publicInbox.indexMaxSize')};
+my $max_size = $opt->{max_size} // $cfg->{lc('publicInbox.indexMaxSize')};
 if (defined $max_size) {
         PublicInbox::Admin::parse_unsigned(\$max_size) or
                 die "`publicInbox.indexMaxSize=$max_size' not parsed\n";
+        $opt->{max_size} = $max_size;
 }
 
-my $bs = $opt->{batchsize} // $cfg->{lc('publicInbox.indexBatchSize')};
+my $bs = $opt->{batch_size} // $cfg->{lc('publicInbox.indexBatchSize')};
 if (defined $bs) {
         PublicInbox::Admin::parse_unsigned(\$bs) or
                 die "`publicInbox.indexBatchSize=$bs' not parsed\n";
+        $opt->{batch_size} = $bs;
 }
-no warnings 'once';
-local $PublicInbox::SearchIdx::BATCH_BYTES = $bs if defined($bs);
-use warnings 'once';
 
 # out-of-the-box builds of Xapian 1.4.x are still limited to 32-bit
 # https://getting-started-with-xapian.readthedocs.io/en/latest/concepts/indexing/limitations.html
 local $ENV{XAPIAN_FLUSH_THRESHOLD} ||= '4294967295' if defined($bs);
 
-my $s = $opt->{sequentialshard} //
+my $s = $opt->{sequential_shard} //
                         $cfg->{lc('publicInbox.indexSequentialShard')};
 if (defined $s) {
         my $v = $cfg->git_bool($s);
         defined($v) or
                 die "`publicInbox.indexSequentialShard=$s' not boolean\n";
-        $opt->{sequentialshard} = $v;
+        $opt->{sequential_shard} = $v;
 }
 
 my $mods = {};
 foreach my $ibx (@ibxs) {
         # XXX: users can shoot themselves in the foot, with opt->{indexlevel}
-        $ibx->{indexlevel} //= $opt->{indexlevel} // ($opt->{xapianonly} ?
+        $ibx->{indexlevel} //= $opt->{indexlevel} // ($opt->{xapian_only} ?
                         'full' : PublicInbox::Admin::detect_indexlevel($ibx));
-        $ibx->{index_max_size} = $max_size;
         PublicInbox::Admin::scan_ibx_modules($mods, $ibx);
 }
 
@@ -112,15 +111,15 @@ for my $ibx (@ibxs) {
         $ibx->{-no_fsync} = 1 if !$opt->{fsync};
 
         my $ibx_opt = $opt;
-        if (defined(my $s = $ibx->{indexsequentialshard})) {
+        if (defined(my $s = $ibx->{lc('indexSequentialShard')})) {
                 defined(my $v = $cfg->git_bool($s)) or die <<EOL;
 publicInbox.$ibx->{name}.indexSequentialShard not boolean
 EOL
-                $ibx_opt = { %$opt, sequentialshard => $v };
+                $ibx_opt = { %$opt, sequential_shard => $v };
         }
         PublicInbox::Admin::index_inbox($ibx, undef, $ibx_opt);
         if ($compact_opt) {
-                local $compact_opt->{jobs} = 0 if $ibx_opt->{sequentialshard};
+                local $compact_opt->{jobs} = 0 if $ibx_opt->{sequential_shard};
                 PublicInbox::Xapcmd::run($ibx, 'compact', $compact_opt);
         }
 }
diff --git a/script/public-inbox-init b/script/public-inbox-init
index 6a959db7..1c8066df 100755
--- a/script/public-inbox-init
+++ b/script/public-inbox-init
@@ -27,7 +27,7 @@ use Cwd qw/abs_path/;
 my ($version, $indexlevel, $skip_epoch, $skip_artnum, $jobs);
 my %opts = (
         'V|version=i' => \$version,
-        'L|indexlevel=s' => \$indexlevel,
+        'L|index-level|indexlevel=s' => \$indexlevel,
         'S|skip|skip-epoch=i' => \$skip_epoch,
         'N|skip-artnum=i' => \$skip_artnum,
         'j|jobs=i' => \$jobs,
@@ -103,11 +103,7 @@ if (-e $pi_config) {
         exit(1) if $conflict;
 
         my $ibx = $cfg->lookup_name($name);
-        if ($ibx) {
-                if (!defined($indexlevel) && $ibx->{indexlevel}) {
-                        $indexlevel = $ibx->{indexlevel};
-                }
-        }
+        $indexlevel //= $ibx->{indexlevel} if $ibx;
 }
 my $pi_config_tmp = $fh->filename;
 close($fh) or die "failed to close $pi_config_tmp: $!\n";