gerrit/Documentation/cmd-index-activate.txt
Borui Tao 39ffbcbe08 doc: fix the example of index activate command
Executing the previous example command of index activate gave the error:
"fatal: gerrit: activate not found". This change adds the "index" to
this example command so that it can be executed correctly.

Bug: Issue 8775
Change-Id: I08fe58d6920810ff0950b1ad62440b930a456126
2018-04-16 20:33:30 -04:00

49 lines
1.1 KiB
Plaintext

= gerrit index activate
== NAME
gerrit index activate - Activate the latest index version available
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit index activate <INDEX>_
--
== DESCRIPTION
Gerrit supports online index schema upgrades. When starting Gerrit for the first
time after an upgrade that requires an index schema upgrade, the online indexer
will be started. If the schema upgrade is a success, the new index will be
activated and if it fails, a statement in the logs will be printed with the
number of successfully/failed indexed changes.
This command allows to activate the latest index even if there were some
failures.
== ACCESS
Caller must be a member of the privileged 'Administrators' group.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<INDEX>::
The index to activate.
Currently supported values:
* changes
* accounts
* groups
== EXAMPLES
Activate the latest change index:
----
$ ssh -p 29418 review.example.com gerrit index activate changes
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]
SEARCHBOX
---------