about summary refs log tree commit homepage
path: root/Documentation/public-inbox-index.pod
diff options
authorEric Wong <e@yhbt.net>2020-02-04 21:44:04 +0000
committerEric Wong <e@yhbt.net>2020-02-04 21:44:28 +0000
commitb7678f950923a0e6fb59a8d17f21292cdb143d63 (patch)
treec75223d4187ced66db149103b1a8dc80dc8f0ccc /Documentation/public-inbox-index.pod
parent253a86b7bf4a3d81118e91f4ebb77844cfbd2b32 (diff)
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.
Diffstat (limited to 'Documentation/public-inbox-index.pod')
1 files changed, 2 insertions, 1 deletions
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 610dacbe..6dc6a3aa 100644
--- 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.