about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2023-08-16 02:26:57 +0000
committerEric Wong <e@80x24.org>2023-08-17 07:22:08 +0000
commitac5545608e8ca2f7f604ff1d0f80965642d737e3 (patch)
treecb74e30fab3e2558a4474c18f81651806c97ea27 /Documentation
parent335170c2ad78d02e2370e573bc627c9e4547f57b (diff)
downloadpublic-inbox-ac5545608e8ca2f7f604ff1d0f80965642d737e3.tar.gz
We'll also be using this for -cindex for associating inboxes
to coderepos.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/public-inbox-extindex.pod6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod
index 66e04060..a5f699c5 100644
--- a/Documentation/public-inbox-extindex.pod
+++ b/Documentation/public-inbox-extindex.pod
@@ -93,6 +93,12 @@ Putting an C<extindex> entry in the config allows L<PublicInbox::WWW>.
 You can have any number of C<extentry.$NAME> sections where C<$NAME>
 is something other than C<all> to display a union of several inboxes.
 
+It is strongly recommended any public inboxes indexed by this command
+have a stable C<publicinbox.$NAME.newsgroup> entry (regardless of
+the presence of an NNTP or IMAP server).  Otherwise, public-inbox-extindex
+will use C<publicinbox.$NAME.inboxdir> as an internal key which can
+cause needless reindexing and require L<--gc> if inboxes are relocated.
+
 See L<public-inbox-config(5)> for more details.
 
 =head1 ENVIRONMENT