about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2021-10-09 05:04:41 -0700
committerEric Wong <e@80x24.org>2021-10-09 21:31:10 +0000
commit8ffed15abbec68463ff3f3105d6651c8a4b5d813 (patch)
treebe0af668a622e5ff6e48af95433d56a4b2b160c5 /Documentation
parent2eac33fffcf1757675a959e69eb34f04e446bd25 (diff)
This mode only checks history for missed/stale messages
and doesn't attempt to reindex messages which are already
Diffstat (limited to 'Documentation')
1 files changed, 22 insertions, 0 deletions
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod
index 2e2e6383..a0fca83c 100644
--- a/Documentation/public-inbox-extindex.pod
+++ b/Documentation/public-inbox-extindex.pod
@@ -40,6 +40,28 @@ C<indexlevel> set to C<basic> and their respective Xapian
 public-inboxes where cross-posting is common, this allows
 significant space savings on Xapian indices.
+=item --gc
+Perform garbage collection instead of indexing.  Use this if
+inboxes are removed from the extindex, or if messages are
+purged or removed from some inboxes.
+=item --reindex
+Forces a re-index of all messages in the extindex.  This can be
+used for in-place upgrades and bugfixes while read-only server
+processes are utilizing the index.  Keep in mind this roughly
+doubles the size of the already-large Xapian database.
+The extindex locks will be released roughly every 10s to
+allow L<public-inbox-mda(1)> and L<public-inbox-watch(1)>
+processes to write to the extindex.
+=item --fast
+Used with C<--reindex>, it will only look for new and stale
+entries and not touch already-indexed messages.
 =head1 FILES