about summary refs log tree commit homepage
path: root/Documentation/public-inbox-xcpdb.pod
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-05-23 09:36:56 +0000
committerEric Wong <e@80x24.org>2019-05-23 17:43:50 +0000
commit6d60c03c298526713eff379fc339ccb030e32630 (patch)
tree171207be528a8b0d0dca719b9970da748f5bc272 /Documentation/public-inbox-xcpdb.pod
parent53a2b98e6fbce92455734bbb7214b0534d5c0bff (diff)
downloadpublic-inbox-6d60c03c298526713eff379fc339ccb030e32630.tar.gz
It is no longer a wrapper around copydatabase(1), since
copydatabase did not recover from DatabaseModifiedError.
Diffstat (limited to 'Documentation/public-inbox-xcpdb.pod')
-rw-r--r--Documentation/public-inbox-xcpdb.pod18
1 files changed, 12 insertions, 6 deletions
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 4ff51867..c47500b6 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -8,13 +8,11 @@ public-inbox-xcpdb - copy Xapian DBs (for format upgrades)
 
 =head1 DESCRIPTION
 
-public-inbox-xcpdb is a wrapper for L<copydatabase(1)> for
+public-inbox-xcpdb is similar to L<copydatabase(1)> for
 upgrading to the latest database format supported by Xapian
-(e.g. "glass" or "honey").
-
-It locks the inbox and prevents other processes such as
-L<public-inbox-watch(1)> and L<public-inbox-mda(1)> from
-writing while it operates.
+(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)>.
 
 This is intended for upgrading the database format used by
 Xapian.  It DOES NOT upgrade the schema used by the
@@ -29,6 +27,14 @@ public-inbox search interface (see L<public-inbox-index(1)>).
 The default config file, normally "~/.public-inbox/config".
 See L<public-inbox-config(5)>
 
+=item XAPIAN_FLUSH_THRESHOLD
+
+The number of documents to update before committing changes to
+disk.  This environment is handled directly by Xapian, refer to
+Xapian API documentation for more details.
+
+Default: 10000
+
 =back
 
 =head1 UPGRADING