From: Eric Wong <e@80x24.org>
Date: Mon, 9 Sep 2019 05:37:45 +0000 (+0000)
Subject: doc config: document indexlevel directive
X-Git-Tag: v1.2.0~108
X-Git-Url: http://www.git.stargrave.org/?p=public-inbox.git;a=commitdiff_plain;h=5872535884e9031771cb865c6fd740066e91aef8

doc config: document indexlevel directive

It was never documented, before.
---

diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod
index a86132be..b0c80e55 100644
--- a/Documentation/public-inbox-config.pod
+++ b/Documentation/public-inbox-config.pod
@@ -91,6 +91,23 @@ C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
 
 Default: none
 
+=item publicinbox.<name>.indexlevel
+
+The indexing level for L<public-inbox-index(1)>
+
+C<basic> only requires L<DBD::SQLite(3pm)> and provides all
+NNTP functionality along with thread-awareness in the WWW
+interface.
+
+C<medium> requires L<Search::Xapian(3pm)> to provide full-text
+term search functionality in the WWW UI.
+
+C<full> also includes positional information used by Xapian to
+allow for searching for phrases using quoted text.
+(e.g. C<"looking for a complete sentence">)
+
+Default: C<full>
+
 =item publicinbox.<name>.httpbackendmax
 
 If a digit, the maximum number of parallel