doc: recommend -compact after --reindex

It's likely a user will be low on space after running --reindex,
so recommend the use of public-inbox-compact afterwards.

And add a few more notes about using public-inbox-compact to
clarify it's for inboxes-only (and not any old Xapian DBs) that
using xapian-compact(1) directly is error-prone and likely to
break things.

diff --git a/Documentation/public-inbox-compact.pod b/Documentation/public-inbox-compact.pod
index 20f9d475dbc10cfdf6652591d3b6173ec0b0f435..6b0c7376ff8927fce95f763f8ff42880593bde67 100644 (file)
--- a/Documentation/public-inbox-compact.pod
+++ b/Documentation/public-inbox-compact.pod
@@ -1,6 +1,6 @@
 =head1 NAME
 
-public-inbox-compact - compact Xapian DBs
+public-inbox-compact - compact Xapian DBs in an inbox
 
 =head1 SYNOPSIS
 
@@ -14,7 +14,8 @@ L<public-inbox-watch(1)> or L<public-inbox-mda(1)> from
 writing while it operates.
 
 It enforces the use of the C<--no-renumber> option of
-L<xapian-compact(1)>
+L<xapian-compact(1)> which is required to work with the
+rest of the public-inbox search code.
 
 =head1 OPTIONS
 

diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 610dacbe7df9b2937dad1f2bd465842209e168da..6dc6a3aac6aa3f82fb8916e71c8e49c9b647b4c6 100644 (file)
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -38,7 +38,8 @@ Forces a search engine re-index of all messages in the
 repository.  This can be used for in-place upgrades while
 NNTP/HTTP server processes are utilizing the index.  Keep in
 mind this roughly doubles the size of the already-large
-Xapian database.
+Xapian database.  Running L<public-inbox-compact(1)>
+afterwards is recommended to release free space.
 
 This does not touch the NNTP article number database.