doc: recommend -compact after --reindex

[public-inbox.git] / Documentation / public-inbox-index.pod

diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 2e0ff69322781633621f68378171c7054f189f91..6dc6a3aac6aa3f82fb8916e71c8e49c9b647b4c6 100644 (file)
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -11,7 +11,7 @@ public-inbox-index [OPTIONS] INBOX_DIR
 public-inbox-index creates and updates the search, overview and
 NNTP article number database used by the read-only public-inbox
 HTTP and NNTP interfaces.  Currently, this requires
-L<DBD::SQlite> and L<DBI> Perl modules.  L<Search::Xapian>
+L<DBD::SQLite> and L<DBI> Perl modules.  L<Search::Xapian>
 is optional, only to support the PSGI search interface.
 
 Once the initial indices are created by public-inbox-index,
@@ -38,10 +38,18 @@ 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.
 
+=item --prune
+
+Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
+is detected.  This is intended to be used in mirrors after running
+L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
+is expunged from mirrors.
+
 =back
 
 =head1 FILES
@@ -52,8 +60,6 @@ C<$GIT_DIR/public-inbox/> directory.
 
 v2 repositories are described in L<public-inbox-v2-format>.
 
-=back
-
 =head1 ENVIRONMENT
 
 =over 8