opendev/gerrit
Code Issues Proposed changes

Restructure the documentation of secondary index settings

Browse Source 
There are several settings that are only used by either the Lucene or
Solr index.  Instead of saying "Only used when the type is X" for each
of those settings, reorganise them into separate subsections specific
to each index.

The sentence describing the names of the indexes mentions names that
are only correct for the Solr index.  Move this under the newly created
Solr section, and add a new sentence with the correct names for the
Lucene index under the Lucene section.

Change-Id: I753895a75e7d9f8007a21b9de91a841bad257675
This commit is contained in:
David Pursehouse 2014-07-09 16:17:49 +09:00
parent 64a9b7404e
commit 902b3ee28f
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
Documentation/config-gerrit.txt
View File

@ -1984,9 +1984,6 @@ Note that after enabling the secondary index, the index must be built
using the link:pgm-reindex.html[reindex program] before restarting the
Gerrit server.
Open and closed changes are indexed in separate indexes named
'changes_open' and 'changes_closed' respectively.
[[index.type]]index.type::
+
Type of secondary indexing employed by Gerrit. The supported
@ -2010,16 +2007,15 @@ Determines the number of threads to use for indexing.
+
Defaults to 1 if not set, or set to a negative value.
[[index.url]]index.url::
+
Only used when the type is `SOLR`.
+
URL of the index server.
==== Lucene configuration
Open and closed changes are indexed in separate indexes named
'open' and 'closed' respectively.
The following settings are only used when the index type is `LUCENE`.
[[index.name.ramBufferSize]]index.name.ramBufferSize::
+
Only used when the type is `LUCENE`.
+
Determines the amount of RAM that may be used for buffering added documents
and deletions before they are flushed to the index. See the
link:http://lucene.apache.org/core/4_6_0/core/org/apache/lucene/index/LiveIndexWriterConfig.html#setRAMBufferSizeMB(double)[
@ -2029,8 +2025,6 @@ Defaults to 16M.
[[index.name.maxBufferedDocs]]index.name.maxBufferedDocs::
+
Only used when the type is `LUCENE`.
+
Determines the minimal number of documents required before the buffered
in-memory documents are flushed to the index. Large values generally
give faster indexing. See the
@ -2042,8 +2036,6 @@ according to RAM usage.
[[index.name.commitWithin]]index.name.commitWithin::
+
Only used when the type is `LUCENE`.
+
Determines the period at which changes are automatically committed to
stable store on disk. This is a costly operation and may block
additional index writes, so lower with caution.
@ -2058,10 +2050,10 @@ Values can be specified using standard time unit abbreviations (`ms`, `sec`,
If negative, `commitWithin` is disabled. Changes are flushed to disk when
the in-memory buffer fills, but only committed and guaranteed to be synced
to disk when the process finishes.
+
Defaults to 300000 ms (5 minutes).
Sample index configuration:
Sample Lucene index configuration:
----
[index]
type = LUCENE
@ -2075,6 +2067,17 @@ Sample index configuration:
maxBufferedDocs = 500
----
==== Solr configuration
Open and closed changes are indexed in separate indexes named
'changes_open' and 'changes_closed' respectively.
The following settings are only used when the index type is `SOLR`.
[[index.url]]index.url::
+
URL of the index server.
[[ldap]]
=== Section ldap