gerrit/Documentation/cmd-gc.txt
Edwin Kempin 619169b4eb Add SSH command to run Git garbage collection
Add a new SSH command that allows to run the Git garbage collection
for specific or all Gerrit projects.

The default parameters for the Git garbage collection can be defined
in the user global Git configuration file of the system user that
runs the Gerrit server.

It is possible to specify repository specific parameters for the
garbage collection in the Git configuration files on repository
level.

All GC runs are logged in a newly added GC log file. This log file
also contains statistics of the repositories that were garbage
collected.

Change-Id: Ie8730e3db785d5e05d5b739cfb1ef87ba515e870
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2013-03-20 21:36:09 -07:00

73 lines
1.6 KiB
Plaintext

gerrit gc
=========
NAME
----
gerrit gc - Run the Git garbage collection
SYNOPSIS
--------
[verse]
'ssh' -p <port> <host> 'gerrit gc'
[--all]
<NAME> ...
DESCRIPTION
-----------
Runs the Git garbage collection for the specified projects.
A Gerrit system administrator can define the default parameters that
should be used for running the garbage collection in the user global
Git configuration file of the system user that runs the Gerrit
server.
Since the user global Git configuration file is overlaid with the Git
configuration on repository level it is possible to specify
repository specific parameters for the garbage collection in the Git
repository configuration of every project.
ACCESS
------
Caller must be a member of the privileged 'Administrators' group,
or have been granted the
link:access-control.html#capability_runGC[Run Garbage Collection]
global capability.
SCRIPTING
---------
This command is intended to be used in scripts.
OPTIONS
-------
<NAME>::
Name of the projects for which the Git garbage collection should be run.
--all::
If specified the Git garbage collection is run for all projects
sequentially.
EXAMPLES
--------
Run the Git garbage collection for the projects 'myProject' and
'yourProject':
=====
$ ssh -p 29418 review.example.com gerrit gc myProject yourProject
collecting garbage for "myProject":
...
done.
collecting garbage for "yourProject":
...
done.
=====
Run the Git garbage collection for all projects:
=====
$ ssh -p 29418 review.example.com gerrit gc --all
=====
GERRIT
------
Part of link:index.html[Gerrit Code Review]