]> git.ipfire.org Git - thirdparty/public-inbox.git/commitdiff
doc/extindex: document --dedupe switch
authorEric Wong <e@80x24.org>
Sat, 25 Nov 2023 20:25:20 +0000 (20:25 +0000)
committerEric Wong <e@80x24.org>
Sun, 26 Nov 2023 01:05:07 +0000 (01:05 +0000)
We've had it since v1.7.0 when -extindex was introduced,
but it was never documented outside of commit messages.

Reviewed-by: Štěpán Němec <stepnem@smrk.net>
Documentation/public-inbox-extindex.pod

index be4ea4de94ddc7784ea58a7014db902adea93f97..b53e45ed4a3eb21869530ff96c6b7d9a14cdb1a7 100644 (file)
@@ -47,6 +47,20 @@ 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 --dedupe=MSGID
+
+=item --dedupe
+
+Rerun deduplication on messages with the given Message-ID or
+all messages if no Message-ID is specified.  Deduplication rules may
+change and evolve over time, especially if filters are involved.
+
+C<--dedupe=MSGID> may be specified multiple times to deduplicate
+multiple Message-IDs.
+
+Use this if you see C<W: BUG? $MSGID not deduplicated properly>
+warnings from WWW logs.
+
 =item --gc
 
 Perform garbage collection instead of indexing.  Use this if
@@ -61,10 +75,6 @@ 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
@@ -131,6 +141,14 @@ Default: none, uses C<publicinbox.indexBatchSize>
 Occasionally, public-inbox will update its schema version and
 require a full index by running this command.
 
+=head1 LOCKING
+
+It is safe to use C<--dedupe>, C<--gc> and C<--reindex> while
+other processes are writing to covered inboxes or extindex.
+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.
+
 =head1 CONTACT
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>