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