unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
* [PATCH] doc: extindex: note the use of `newsgroup' entries
@ 2023-08-16  2:26 Eric Wong
  0 siblings, 0 replies; only message in thread
From: Eric Wong @ 2023-08-16  2:26 UTC (permalink / raw)
  To: meta

We'll also be using this for -cindex for associating inboxes
to coderepos.
---
 coderepo <=> inbox association is proving tricky and slow :<
 and xapian-delve + quest CLI tools aren't enough...

 Documentation/public-inbox-extindex.pod | 6 ++++++
 1 file changed, 6 insertions(+)

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

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2023-08-16  2:28 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-08-16  2:26 [PATCH] doc: extindex: note the use of `newsgroup' entries Eric Wong

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).