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 10:37:38 +0000
committerEric Wong <e@80x24.org>2019-05-23 17:43:51 +0000
commit666f1b8f5c7c76333df4e1296c1668abf04f210f (patch)
tree127e4befde4493285217e269d0b037e3829b5212 /Documentation/public-inbox-xcpdb.pod
parentbb279f4f305649c99dabdbcc0f45fc42c9be8e7e (diff)
downloadpublic-inbox-666f1b8f5c7c76333df4e1296c1668abf04f210f.tar.gz
-index documentation avoid redundant v1 information and refers
readers to apropriate v1/v2 manpages.  Search::Xapian can also
be optional, now, as only the PSGI search interface uses it.

Favor "INBOX_DIR" where appropriate, since "REPO_DIR" can be
confused for code repos which we also support.

XAPIAN_FLUSH_THRESHOLD is documented for all relevant
bulk commands.
Diffstat (limited to 'Documentation/public-inbox-xcpdb.pod')
-rw-r--r--Documentation/public-inbox-xcpdb.pod5
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index c47500b6..5697dcdd 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-public-inbox-xcpdb - copy Xapian DBs (for format upgrades)
+public-inbox-xcpdb - upgrade Xapian DB formats
 
 =head1 SYNOPSIS
 
@@ -16,7 +16,8 @@ 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
-public-inbox search interface (see L<public-inbox-index(1)>).
+public-inbox PSGI search interface (see
+L<public-inbox-index(1)>).
 
 =head1 ENVIRONMENT