From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: X-Spam-Status: No, score=-4.0 required=3.0 tests=ALL_TRUSTED,BAYES_00 shortcircuit=no autolearn=ham autolearn_force=no version=3.4.2 Received: from localhost (dcvr.yhbt.net [127.0.0.1]) by dcvr.yhbt.net (Postfix) with ESMTP id 00B0E1F9FC for ; Wed, 3 Nov 2021 08:34:47 +0000 (UTC) From: Eric Wong To: meta@public-inbox.org Subject: [PATCH 1/3] doc: extindex: document current behavior + knobs Date: Wed, 3 Nov 2021 08:34:44 +0000 Message-Id: <20211103083446.29264-2-e@80x24.org> In-Reply-To: <20211103083446.29264-1-e@80x24.org> References: <20211103083446.29264-1-e@80x24.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit List-Id: 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..topdir + +The directory of an external index. See +L for more details. + +=item extindex..url + +Identical to LnameE.url>, but for +external indices + +=item extindex..coderepo + +Identical to LnameE.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 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 =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 =head1 CONFIGURATION -... TODO, see L +public-inbox-extindex does not currently write to the +L file, configuration may be entered +manually. The extindex name of C 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 for more details. =head1 ENVIRONMENT