]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: note -compact and -xcpdb are rarely used
authorEric Wong <e@yhbt.net>
Thu, 20 Aug 2020 20:24:35 +0000 (20:24 +0000)
committerEric Wong <e@yhbt.net>
Thu, 20 Aug 2020 21:08:25 +0000 (21:08 +0000)
Slowly improving the learning curve...

Documentation/public-inbox-compact.pod
Documentation/public-inbox-xcpdb.pod

index 8e463ab10c7e190e545c5149cb9c27d85c6d47fc..4e9b6d9fa689ee248275ba43ad8909fb87afb250 100644 (file)
@@ -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
index 2b38f1da7d987d6cfdf9f9a8eec56fb32faddce7..52939894fc9795c3234b4009fe07b9715b4fe573 100644 (file)
@@ -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