blob: 07b899ac747b10f024c90e92d33c7aea36ab37f9 [file] [log] [blame]
Edwin Kempin619169b2012-02-09 15:47:52 +01001gerrit gc
2=========
3
4NAME
5----
6gerrit gc - Run the Git garbage collection
7
8SYNOPSIS
9--------
10[verse]
11'ssh' -p <port> <host> 'gerrit gc'
12 [--all]
13 <NAME> ...
14
15DESCRIPTION
16-----------
17Runs the Git garbage collection for the specified projects.
18
19A Gerrit system administrator can define the default parameters that
20should be used for running the garbage collection in the user global
21Git configuration file of the system user that runs the Gerrit
22server.
23
24Since the user global Git configuration file is overlaid with the Git
25configuration on repository level it is possible to specify
26repository specific parameters for the garbage collection in the Git
27repository configuration of every project.
28
29ACCESS
30------
31Caller must be a member of the privileged 'Administrators' group,
32or have been granted the
33link:access-control.html#capability_runGC[Run Garbage Collection]
34global capability.
35
36SCRIPTING
37---------
38This command is intended to be used in scripts.
39
40OPTIONS
41-------
42<NAME>::
43 Name of the projects for which the Git garbage collection should be run.
44
45--all::
46 If specified the Git garbage collection is run for all projects
47 sequentially.
48
49EXAMPLES
50--------
51
52Run the Git garbage collection for the projects 'myProject' and
53'yourProject':
54=====
55 $ ssh -p 29418 review.example.com gerrit gc myProject yourProject
56 collecting garbage for "myProject":
57 ...
58 done.
59
60 collecting garbage for "yourProject":
61 ...
62 done.
63=====
64
65Run the Git garbage collection for all projects:
66=====
67 $ ssh -p 29418 review.example.com gerrit gc --all
68=====
69
70GERRIT
71------
72Part of link:index.html[Gerrit Code Review]