opendev/gerrit
Code Issues Proposed changes

[DOC] Improve wording for pgm-init

Browse Source 
Clarify the behaviour on re-running init on existing
sites.

Change-Id: I63f63464fb4d89470405002ef5f434034648420b
This commit is contained in:
Björn Pedersen
2016-05-02 13:53:52 +02:00
committed by David Pursehouse
parent 4ad6bef7a2
commit 90200ef368
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/pgm-init.txt
View File

@@ -1,7 +1,7 @@
= init
== NAME
init - Initialize a new Gerrit server installation
init - Initialize/Upgrade a Gerrit server installation
== SYNOPSIS
--
@@ -25,13 +25,14 @@ for some basic setup prior to writing default configuration files
into a newly created `$site_path`.
If run in an existing `$site_path`, init will upgrade some resources
as necessary.
(e.g. DB schema, plugins) as necessary.
== OPTIONS
--batch::
Run in batch mode, skipping interactive prompts. Reasonable
configuration defaults are chosen based on the whims of
the Gerrit developers.
Run in batch mode, skipping interactive prompts. For a fresh
install, reasonable configuration defaults are chosen based
on the whims of the Gerrit developers. On upgrades, the settings
in gerrit.config are respected.
+
If during a schema migration unused objects (e.g. tables, columns)
are detected they are *not* automatically dropped, but only a list of