opendev/gerrit
Code Issues Proposed changes

Minor cleanup in the Elasticsearch configuration documentation

Browse Source 
- Replace single and double quotes with backticks

- Fix a couple of minor grammatical nits

Change-Id: I50307310ae6f57bb243a65ffd1e6b40dac98e79f
This commit is contained in:
David Pursehouse
2018-05-10 15:40:47 +09:00
parent eb2f45c84e
commit 997cf2a088
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/config-gerrit.txt
View File

@@ -2795,13 +2795,13 @@ WARNING: The Elasticsearch support has only been tested with Elasticsearch
version 2.4.x. Support for other versions is not guaranteed.
Open and closed changes are indexed in a single index, separated
into types 'open_changes' and 'closed_changes' respectively.
into types `open_changes` and `closed_changes` respectively.
[[elasticsearch.prefix]]elasticsearch.prefix::
+
This setting can be used to prefix index names to allow multiple Gerrit
instances in a single Elasticsearch cluster. Prefix 'gerrit1_' would result in a
change index named 'gerrit1_changes_0001'.
instances in a single Elasticsearch cluster. Prefix `gerrit1_` would result in a
change index named `gerrit1_changes_0001`.
+
Not set by default.
@@ -2827,7 +2827,7 @@ Defaults to `false`.
+
How long should Gerrit waits for connection.
+
The value is in the usual time-unit format like "1 m", "5 m".
The value is in the usual time-unit format like `1 m`, `5 m`.
+
Defaults to `5 m`
@@ -2835,31 +2835,31 @@ Defaults to `5 m`
+
How long connection can stay in idle.
+
The value is in the usual time-unit format like "1 m", "5 m".
The value is in the usual time-unit format like `1 m`, `5 m`.
+
Defaults to `5 m`
[[elasticsearch.maxTotalConnection]]elasticsearch.maxTotalConnection::
+
How many connections can be spawn simultaneously.
How many connections can be spawned simultaneously.
+
Defaults to `1`
[[elasticsearch.maxReadTimeout]]elasticsearch.maxReadTimeout::
+
Timeout for the read operation.
Timeout for read operations.
+
The value is in the usual time-unit format like "1 m", "5 m".
The value is in the usual time-unit format like `1 m`, `5 m`.
+
Defaults to `5 m`
==== Elasticsearch server(s) configuration
Each section correspond to one Elasticsearch server.
Each section corresponds to one Elasticsearch server.
[[elasticsearch.name.protocol]]elasticsearch.name.protocol::
+
Elasticsearch server protocol [http|https].
Elasticsearch server protocol. Can be `http` or `https`.
+
Defaults to `http`.