opendev/gerrit
Code Issues Proposed changes

Merge "doc: add option and example section to ssh index command"

Browse Source
This commit is contained in:
David Pursehouse 2016-07-21 00:37:36 +00:00 committed by Gerrit Code Review
commit 02e9d0bda9
2 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/cmd-index-activate.txt
View File

@ -6,7 +6,7 @@ gerrit index activate - Activate the latest index version available
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit index activate <index>_
_ssh_ -p <port> <host> _gerrit index activate <INDEX>_
--
== DESCRIPTION
@ -19,15 +19,26 @@ number of successfully/failed indexed changes.
This command allows to activate the latest index even if there were some
failures.
The <index> argument controls which secondary index is activated. Currently, the
only supported value is "changes".
== 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
== EXAMPLES
Activate the latest change index:
----
$ ssh -p 29418 review.example.com gerrit activate changes
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]

19
Documentation/cmd-index-start.txt
View File

@ -6,7 +6,7 @@ gerrit index start - Start the online indexer
== SYNOPSIS
[verse]
--
_ssh_ -p <port> <host> _gerrit index start_ <index>
_ssh_ -p <port> <host> _gerrit index start_ <INDEX>
--
== DESCRIPTION
@ -20,15 +20,26 @@ This command allows restarting the online indexer without having to restart
Gerrit. This command will not start the indexer if it is already running or if
the active index is the latest.
The <index> argument controls which secondary index is started. Currently, the
only supported value is "changes".
== ACCESS
Caller must be a member of the privileged 'Administrators' group.
== SCRIPTING
This command is intended to be used in scripts.
== OPTIONS
<INDEX>::
Restart the online indexer on this secondary index.
Currently supported values:
* changes
* accounts
== EXAMPLES
Start the online indexer for the changes index:
----
$ ssh -p 29418 review.example.com gerrit index start changes
----
GERRIT
------
Part of link:index.html[Gerrit Code Review]