Add initial documentation for the 'reindex' program

The initial documentation includes only a summary and list of
available options.

Further documentation needs to be added later:

- Examples
- Link to index configuration documentation (which doesn't exist yet)

Change-Id: Id2da34b23513cda5da4485703f8ff69bd2519b65
This commit is contained in:
David Pursehouse
2013-08-23 12:32:07 +09:00
parent 0b052a5bca
commit c34cf441e7
2 changed files with 43 additions and 0 deletions

View File

@@ -23,6 +23,9 @@ link:pgm-gsql.html[gsql]::
link:pgm-prolog-shell.html[prolog-shell]::
Simple interactive Prolog interpreter.
link:pgm-reindex.html[reindex]::
Rebuild the secondary index.
link:pgm-rulec.html[rulec]::
Compile project-specific Prolog rules to JARs.

View File

@@ -0,0 +1,40 @@
reindex
=======
NAME
----
reindex - Rebuild the secondary index
SYNOPSIS
--------
[verse]
'java' -jar gerrit.war 'reindex' [<OPTIONS>]
DESCRIPTION
-----------
Rebuilds the secondary index.
OPTIONS
-------
--threads::
Number of threads to use for indexing.
--schema-version::
Schema version to reindex; default is most recent version.
--output::
Prefix for output; path for local disk index, or prefix for remote index.
--verbose::
Output debug information for each change.
--dry-run::
Dry run. Don't write anything to index.
CONTEXT
-------
The secondary index must be enabled.
GERRIT
------
Part of link:index.html[Gerrit Code Review]