about summary refs log tree commit homepage
path: root/Documentation/public-inbox-index.pod
diff options
authorEric Wong <e@80x24.org>2020-12-23 23:02:55 +0000
committerEric Wong <e@80x24.org>2020-12-24 09:01:10 +0000
commitd6d3159d1ae25f67c09dd189e6df36795a3b8bfa (patch)
tree82ceed46b01e662633952789d3bdba9b442fa702 /Documentation/public-inbox-index.pod
parent74e705e24dffaf4dcb3952910678df7529783762 (diff)
In most cases, this ensures users will only have to opt-in to
using -extindex once and won't have to issue extra commands
to keep external indices up-to-date when using

Since we support arbitrary numbers of external indices for
ease-of-development, we'll support repeating "-E"
("--update-extindex=") in case users want to test changes in
Diffstat (limited to 'Documentation/public-inbox-index.pod')
1 files changed, 18 insertions, 1 deletions
diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod
index 0848e860..2d5df930 100644
--- a/Documentation/public-inbox-index.pod
+++ b/Documentation/public-inbox-index.pod
@@ -162,6 +162,23 @@ See L<public-inbox-init(1)/--skip-docdata> for description and caveats.
 Available in public-inbox 1.6.0+.
+=item --update-extindex=EXTINDEX, -E
+Update the given external index (L<public-inbox-extindex-format(5)>.
+Either the configured section name (e.g. C<all>) or a directory name
+may be specified.
+Defaults to C<all> if C<[extindex "all"]> is configured,
+otherwise no external indices are updated.
+May be specified multiple times in rare cases where multiple
+external indices are configured.
+=item --no-update-extindex
+Do not update the C<all> external index by default.  This negates
+all uses of C<-E> / C<--update-extindex=> on the command-line.
 =head1 FILES
@@ -297,4 +314,4 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 =head1 SEE ALSO
-L<Search::Xapian>, L<DBD::SQLite>
+L<Search::Xapian>, L<DBD::SQLite>, L<public-inbox-extindex-format(5)>