opendev/gerrit
Code Issues Proposed changes

Doc: Fix minor nits in config-auto-site-initialization

Browse Source 
Change-Id: Ie0d671198d5f6741b2ff30cac2041dfa9867f1d7
This commit is contained in:
David Pursehouse
2017-01-23 06:15:17 +00:00
parent 25d59ce754
commit c19163c310
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Documentation/config-auto-site-initialization.txt
View File

@@ -8,7 +8,7 @@ and upgrade of an existing site are supported. By default, all packaged
plugins will be installed when Gerrit is deployed in a servlet container plugins will be installed when Gerrit is deployed in a servlet container
and the location of the Gerrit distribution can be determined at and the location of the Gerrit distribution can be determined at
runtime. It is also possible to install only a subset of packaged runtime. It is also possible to install only a subset of packaged
plugins or not install any plugin. plugins or not install any plugins.
This feature may be useful for such setups where Gerrit administrators This feature may be useful for such setups where Gerrit administrators
don't have direct access to the database and the file system of the don't have direct access to the database and the file system of the
@@ -20,8 +20,8 @@ container faster to setup as the init step could be skipped.
== Gerrit Configuration == Gerrit Configuration
The site initialization will be performed only if the `gerrit.init` The site initialization will be performed only if the `gerrit.init`
system property exists (the value of the property is not used, only the system property exists. The value of the property is not used; only the
existence of the property matters). existence of the property matters.
If the `gerrit.site_path` system property is defined then the init is If the `gerrit.site_path` system property is defined then the init is
run for that site. The database connectivity, in that case, is defined run for that site. The database connectivity, in that case, is defined
@@ -44,17 +44,17 @@ JNDI property.
Defining the `jdbc/ReviewDb` JNDI property for an H2 database under the Defining the `jdbc/ReviewDb` JNDI property for an H2 database under the
path defined by either `gerrit.site_path` or `gerrit.init_path` will path defined by either `gerrit.site_path` or `gerrit.init_path` will
cause an incomplete auto initialization and Gerrit will fail to start. cause an incomplete auto initialization and Gerrit will fail to start.
Opening a connection to such database will create a subfolder under the Opening a connection to such a database will create a subfolder under the
site path folder (in order to create the H2 database) and Gerrit will site path folder (in order to create the H2 database) and Gerrit will
not any more consider that site path to be new and, because of that, no longer consider that site path to be new and, because of that,
skip some required initialization steps (for example, Lucene index skip some required initialization steps (for example, Lucene index
creation). In order to auto initialize Gerrit with an embedded H2 creation). In order to auto initialize Gerrit with an embedded H2
database use the `gerrit.site_path` to define the location of the review database use the `gerrit.site_path` to define the location of the review
site and don't define a JNDI resource with a URL under that path. site and don't define a JNDI resource with a URL under that path.
If the 'gerrit.install_plugins' property is not defined then all packaged If the `gerrit.install_plugins` property is not defined then all packaged
plugins will be installed. If it is defined then it is parsed as a plugins will be installed. If it is defined then it is parsed as a
comma separated list of plugin names to install. If the value is an comma-separated list of plugin names to install. If the value is an
empty string then no plugin will be installed. empty string then no plugin will be installed.
=== Example 1 === Example 1