From 11b8815b47b334a1726e517e0a443182f835af74 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Thu, 20 Aug 2020 20:24:35 +0000 Subject: [PATCH] doc: note -compact and -xcpdb are rarely used Slowly improving the learning curve... --- Documentation/public-inbox-compact.pod | 5 +++++ Documentation/public-inbox-xcpdb.pod | 3 +++ 2 files changed, 8 insertions(+) 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 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 +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, L, L, and L. +This command is rarely used, as Xapian DB formats rarely +change. + =head1 OPTIONS =over -- 2.44.0