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-10 02:11:55 +0000
committerEric Wong <e@yhbt.net>2020-08-10 05:56:02 +0000
commit425acc673f5394b0e8472558921db949eac034a5 (patch)
tree3173ebfaabda7d1e0be11bc6338145215843c91d /Documentation/public-inbox-xcpdb.pod
parentc1e29b1a8ef1aeafc21c5524ae7e20b467627cf5 (diff)
downloadpublic-inbox-425acc673f5394b0e8472558921db949eac034a5.tar.gz
These rarely-used commands have some caveats that needed
expanding on.
Diffstat (limited to 'Documentation/public-inbox-xcpdb.pod')
-rw-r--r--Documentation/public-inbox-xcpdb.pod15
1 files changed, 13 insertions, 2 deletions
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 89eed079..2ed4c582 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -11,8 +11,9 @@ public-inbox-xcpdb - upgrade Xapian DB formats
 public-inbox-xcpdb is similar to L<copydatabase(1)> for
 upgrading to the latest database format supported by Xapian
 (e.g. "glass" or "honey"), but is designed to tolerate and
-recover from Xapian database modifications from
-L<public-inbox-watch(1)> or L<public-inbox-mda(1)>.
+accept parallel Xapian database modifications from
+L<public-inbox-watch(1)>, L<public-inbox-mda(1)>,
+L<public-inbox-learn(1)>, and L<public-inbox-index(1)>.
 
 =head1 OPTIONS
 
@@ -80,6 +81,16 @@ used by public-inbox, NOT users upgrading public-inbox itself.
 In particular, it DOES NOT upgrade the schema used by the
 PSGI search interface (see L<public-inbox-index(1)>).
 
+=head1 LIMITATIONS
+
+Do not use L<public-inbox-purge(1)> or L<public-inbox-edit(1)>
+while this is running; old (purged or edited data) may show up.
+
+Normal invocations L<public-inbox-index(1)> can safely run
+while this is running, too.  However, reindexing via the
+L<public-inbox-index(1)/--reindex> switch will be a waste of
+computing resources.
+
 =head1 CONTACT
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>