diff options
author | Eric Wong <e@80x24.org> | 2021-11-03 08:34:44 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-11-03 18:32:10 +0000 |
commit | 3ae2a4c3a8f22c0fe08c5c4c26919e311195c23e (patch) | |
tree | fcbac7bfccb3862f1bafba4090d25328c4d530e3 /Documentation | |
parent | 1f1b1f0e22f7b4cbe5c8e843c1932222c0461393 (diff) | |
download | public-inbox-3ae2a4c3a8f22c0fe08c5c4c26919e311195c23e.tar.gz |
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.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/public-inbox-config.pod | 16 | ||||
-rw-r--r-- | 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 a5bc67fd..43e54ed4 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. + =back =head2 NAMED LIMITER (PSGI) diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index a0fca83c..9731dfb0 100644 --- a/Documentation/public-inbox-extindex.pod +++ b/Documentation/public-inbox-extindex.pod @@ -10,9 +10,6 @@ public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all =head1 DESCRIPTION -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)> =head1 CONFIGURATION -... 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. =head1 ENVIRONMENT |