From: Eric Wong <e@yhbt.net>
Date: Thu, 20 Aug 2020 20:24:35 +0000 (+0000)
Subject: doc: note -compact and -xcpdb are rarely used
X-Git-Tag: v1.6.0~133
X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=commitdiff_plain;h=11b8815b47b334a1726e517e0a443182f835af74

doc: note -compact and -xcpdb are rarely used

Slowly improving the learning curve...
---

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 8e463ab1..4e9b6d9f 100644
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -19,6 +19,11 @@ It enforces the use of the C<--no-renumber> option of
 L<xapian-compact(1)> which is required to work with the
 rest of the public-inbox search code.
 
+This command is rarely needed for active inboxes.
+
+Using the C<--compact> option of L<public-inbox-index(1)>
+is recommended, instead, and only when doing a C<--reindex>.
+
 =head1 OPTIONS
 
 =over
diff --git a/Documentation/public-inbox-xcpdb.pod b/Documentation/public-inbox-xcpdb.pod
index 2b38f1da..52939894 100644
--- a/Documentation/public-inbox-xcpdb.pod
+++ b/Documentation/public-inbox-xcpdb.pod
@@ -17,6 +17,9 @@ 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)>.
 
+This command is rarely used, as Xapian DB formats rarely
+change.
+
 =head1 OPTIONS
 
 =over