From: Eric Wong (Contractor, The Linux Foundation) <e@80x24.org>
Date: Sun, 9 Jun 2019 02:51:46 +0000 (+0000)
Subject: doc: document the --prune option for -index
X-Git-Tag: v1.2.0~179^2~5
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=d209b8190d4f3fdf60e577ee8372288d0a76ac70;p=public-inbox.git

doc: document the --prune option for -index

We've had it around for a while, but I forgot to document it :x
---

diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 6d2a4203..7679376c 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -42,6 +42,13 @@ Xapian database.
 
 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