gerrit/Documentation/pgm-ExportReviewNotes.txt
David Pursehouse d24be9daf9 Documentation: Add documentation of refs/notes/review
The refs/notes/review namespace is a useful feature of Gerrit, but
it is not documented.

Add a new page briefly describing refs/notes/review and its contents.

Change-Id: If23da4914d72c5af07d43308b2200a22678bbfc2
2012-07-30 14:07:36 +02:00

51 lines
1.1 KiB
Plaintext

ExportReviewNotes
=================
NAME
----
ExportReviewNotes - Export successful reviews to link:refs-notes-review.html[refs/notes/review]
SYNOPSIS
--------
[verse]
'java' -jar gerrit.war 'ExportReviewNotes' -d <SITE_PATH>
DESCRIPTION
-----------
Scans every submitted change and creates an initial notes
branch detailing the previous submission information for
each merged change.
This task can take quite some time, but can run in the background
concurrently to the server if the database is MySQL or PostgreSQL.
If the database is H2, this task must be run by itself.
OPTIONS
-------
-d::
\--site-path::
Location of the gerrit.config file, and all other per-site
configuration data, supporting libraries and log files.
\--threads::
Number of threads to perform the scan work with. Default: 2.
CONTEXT
-------
This command can only be run on a server which has direct
connectivity to the metadata database, and local access to the
managed Git repositories.
EXAMPLES
--------
To generate all review information:
====
$ java -jar gerrit.war ExportReviewNotes -d site_path --threads 16
====
GERRIT
------
Part of link:index.html[Gerrit Code Review]