user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <>
Subject: [PATCH 1/3] doc: extindex: document current behavior + knobs
Date: Wed,  3 Nov 2021 08:34:44 +0000	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

I'm not really sure if extindex writing to the config file
is a good idea (since -index doesn't, as -init exists).
Just document what it does and let the user handle it, since
the config file shouldn't be daunting to new users.
 Documentation/public-inbox-config.pod   | 16 ++++++++++++++++
 Documentation/public-inbox-extindex.pod | 17 +++++++++++++----
 2 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index a5bc67fd6328..43e54ed42d9d 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -358,6 +358,22 @@ more than once, in which case the values are merged.
 Default: none
+=item extindex.<name>.topdir
+The directory of an external index.  See
+L<public-inbox-extindex(1)> for more details.
+=item extindex.<name>.url
+Identical to L</publicinbox.E<lt>nameE<gt>.url>, but for
+external indices
+=item extindex.<name>.coderepo
+Identical to L</publicinbox.E<lt>nameE<gt>.coderepo>, but for
+external indices.  Code repos may be freely associated with
+any number of public inboxes and external indices.
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod
index a0fca83c6255..9731dfb0d2a7 100644
--- a/Documentation/public-inbox-extindex.pod
+++ b/Documentation/public-inbox-extindex.pod
@@ -10,9 +10,6 @@ public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all
-FIXME: behavior not finalized  It should probably write to the
-config file the first time --all is used.
 public-inbox-extindex creates and updates an external search and
 overview database used by the read-only public-inbox PSGI (HTTP),
 NNTP, and IMAP interfaces.  This requires either the
@@ -70,7 +67,19 @@ L<public-inbox-extindex-format(5)>
-... TODO, see L<public-inbox-index(5)>
+public-inbox-extindex does not currently write to the
+L<public-inbox-config(5)> file, configuration may be entered
+manually.  The extindex name of C<all> is a special case which
+corresponds to indexing C<--all> inboxes.  An example for
+C<--all> is as follows:
+	[extindex "all"]
+		topdir = /path/to/extindex_dir
+		url = all
+		coderepo = foo
+		coderepo = bar
+See L<public-inbox-config(5)> for more details.

  reply	other threads:[~2021-11-03  8:34 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-11-03  8:34 [PATCH 0/3] doc: extindex-related updates Eric Wong
2021-11-03  8:34 ` Eric Wong [this message]
2021-11-03  8:34 ` [PATCH 2/3] doc: -clone|lei add-external: add bit about the Makefile Eric Wong
2021-11-03  8:34 ` [PATCH 3/3] doc: relnotes: 1.7.0: move extindex, note search results change Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \
    --subject='Re: [PATCH 1/3] doc: extindex: document current behavior + knobs' \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

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).