gerrit/Documentation/cmd-gc.txt
Yuxuan 'fishy' Wang 61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00

73 lines
1.6 KiB
Plaintext

= gerrit gc
== NAME
gerrit gc - Run the Git garbage collection
== SYNOPSIS
--
'ssh' -p <port> <host> 'gerrit gc'
[--all]
[--show-progress]
<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.
--show-progress::
If specified progress information is shown.
== 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]
SEARCHBOX
---------