From 6d458430ac589bd67ec1ecf729e421a16c527071 Mon Sep 17 00:00:00 2001 From: David Pursehouse Date: Fri, 23 Aug 2013 16:17:18 +0900 Subject: [PATCH] Add documentation section for secondary index configuration Add a new `index` section and document the `index.type` flag. Add a link to the new section from the `reindex` program documentation. Change-Id: I52fd25d07352276002898482e8e205de43cb08bc --- Documentation/config-gerrit.txt | 26 ++++++++++++++++++++++++++ Documentation/pgm-reindex.txt | 3 ++- 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index 3538145da8..3c35054d92 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -1783,6 +1783,32 @@ If not absolute, the path is resolved relative to `$site_path`. If the file doesn't exist or can't be read the default robots.txt file bundled with the .war will be used instead. +[[index]]Section index +~~~~~~~~~~~~~~~~~~~~~~ + +The index section configures the secondary index. + +[[index.type]]index.type:: ++ +Type of secondary indexing employed by Gerrit. The supported +values are: ++ +* `LUCENE` ++ +A link:http://lucene.apache.org/[Lucene] index is used. ++ +* `SOLR` ++ +A link:http://lucene.apache.org/solr/[Solr] index is used. ++ +* `SQL` ++ +No secondary index. Not all query operators are supported. Other +query operators are routed through the standard SQL query engine. + ++ +By default, `SQL`. + [[ldap]]Section ldap ~~~~~~~~~~~~~~~~~~~~ diff --git a/Documentation/pgm-reindex.txt b/Documentation/pgm-reindex.txt index 06e9e033bc..2b44f6badf 100644 --- a/Documentation/pgm-reindex.txt +++ b/Documentation/pgm-reindex.txt @@ -33,7 +33,8 @@ OPTIONS CONTEXT ------- -The secondary index must be enabled. +The secondary index must be enabled. See +link:config-gerrit.html#index.type[index.type]. GERRIT ------