about summary refs log tree commit homepage
path: root/Documentation/public-inbox-xcpdb.pod
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-08-12 09:17:18 +0000
committerEric Wong <e@yhbt.net>2020-08-13 02:22:59 +0000
commit75b5402ed1e989cd63f4f3ce4237cdad908e3984 (patch)
tree0ef3ed169bc5732f776314cb8dd2cdf989b2b11a /Documentation/public-inbox-xcpdb.pod
parentfc689933e6e181f0bed62ff21fe83ab94bdc1969 (diff)
downloadpublic-inbox-75b5402ed1e989cd63f4f3ce4237cdad908e3984.tar.gz
--sequential-shard also disables the copy parallelism (--jobs),
so it can be useful for systems unable to handle parallel random
I/O but still want many shards.

There was a missing "use strict", too, which is fixed.
Diffstat (limited to 'Documentation/public-inbox-xcpdb.pod')
-rw-r--r--Documentation/public-inbox-xcpdb.pod19
1 files changed, 18 insertions, 1 deletions
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 2ed4c582..62a28c0a 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -19,7 +19,7 @@ L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
 
 =over
 
-=item --compact
+=item -c, --compact
 
 In addition to performing the copy operation, run L<xapian-compact(1)>
 on each Xapian shard after copying but before finalizing it.
@@ -52,6 +52,23 @@ Disable L<fsync(2)> and L<fdatasync(2)>.
 
 Available in public-inbox 1.6.0 (PENDING).
 
+=item --sequential-shard
+
+Copy each shard sequentially, ignoring C<--jobs>.  This also
+affects indexing done at the end of a run.
+
+=item --batch-size=BYTES
+
+=item --max-size=BYTES
+
+See L<public-inbox-index(1)> for a description of these options.
+
+These indexing options indexing at the end of a run.
+C<public-inbox-xcpdb> may run in parallel with with
+L<public-inbox-index(1)>, and C<public-inbox-xcpdb> needs to
+reindex changes made to the old Xapian DBs by
+L<public-inbox-index(1)> while it was running.
+
 =back
 
 =head1 ENVIRONMENT