From 5073e8eceaf0ad20ddf9a5515e1d0aa7acbad5b3 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Sat, 25 Nov 2023 20:25:20 +0000 Subject: doc/extindex: document --dedupe switch MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- Documentation/public-inbox-extindex.pod | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) (limited to 'Documentation') diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index be4ea4de..b53e45ed 100644 --- a/Documentation/public-inbox-extindex.pod +++ b/Documentation/public-inbox-extindex.pod @@ -47,6 +47,20 @@ C set to C 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 +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 and L -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 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 and L +processes to write to the extindex. + =head1 CONTACT Feedback welcome via plain-text mail to L -- cgit v1.2.3-24-ge0c7