]> Sergey Matveev's repositories - public-inbox.git/commitdiff
extindex: document --all and indexlevel=basic interaction
authorEric Wong <e@80x24.org>
Tue, 31 Aug 2021 22:23:00 +0000 (22:23 +0000)
committerEric Wong <e@80x24.org>
Wed, 1 Sep 2021 00:18:57 +0000 (00:18 +0000)
Cache is expensive, so help users save on storage by documenting
this behavior.

Documentation/public-inbox-extindex.pod

index fed5017b8efbeb334b35007128da1acfaf694547..2e2e6383b79b35c31f7be30ed1daa7996a1674dd 100644 (file)
@@ -29,6 +29,17 @@ along with L<DBD::SQLite> and L<DBI> Perl modules.
 
 ... TODO, see L<public-inbox-index(5)>
 
+=item --all
+
+Index all C<publicinbox> entries in C<PI_CONFIG>.
+
+C<publicinbox> entries indexed by C<public-inbox-extindex> can
+have full Xapian searching abilities with the per-C<publicinbox>
+C<indexlevel> set to C<basic> and their respective Xapian
+(C<xap15> or C<xapian15>) directories removed.  For multiple
+public-inboxes where cross-posting is common, this allows
+significant space savings on Xapian indices.
+
 =back
 
 =head1 FILES