]>
Commit | Line | Data |
---|---|---|
30f610b7 SP |
1 | git-gc(1) |
2 | ========= | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-gc - Cleanup unnecessary files and optimize the local repository | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
ae4e89e5 | 12 | 'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack] |
30f610b7 SP |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
16 | Runs a number of housekeeping tasks within the current repository, | |
17 | such as compressing file revisions (to reduce disk space and increase | |
b586a96a NTND |
18 | performance), removing unreachable objects which may have been |
19 | created from prior invocations of 'git add', packing refs, pruning | |
20 | reflog, rerere metadata or stale working trees. | |
30f610b7 SP |
21 | |
22 | Users are encouraged to run this task on a regular basis within | |
23 | each repository to maintain good disk space utilization and good | |
05f30452 NP |
24 | operating performance. |
25 | ||
0b444cdb | 26 | Some git commands may automatically run 'git gc'; see the `--auto` flag |
05f30452 NP |
27 | below for details. If you know what you're doing and all you want is to |
28 | disable this behavior permanently without further considerations, just do: | |
29 | ||
30 | ---------------------- | |
31 | $ git config --global gc.auto 0 | |
32 | ---------------------- | |
30f610b7 | 33 | |
e3ff4b24 JH |
34 | OPTIONS |
35 | ------- | |
36 | ||
0d7566a5 | 37 | --aggressive:: |
0b444cdb | 38 | Usually 'git gc' runs very quickly while providing good disk |
5049012f | 39 | space utilization and performance. This option will cause |
0b444cdb | 40 | 'git gc' to more aggressively optimize the repository at the expense |
0d7566a5 | 41 | of taking much more time. The effects of this optimization are |
5049012f | 42 | persistent, so this option only needs to be used occasionally; every |
0d7566a5 | 43 | few hundred changesets or so. |
e9831e83 JH |
44 | |
45 | --auto:: | |
0b444cdb | 46 | With this option, 'git gc' checks whether any housekeeping is |
d7e56dbc JK |
47 | required; if not, it exits without performing any work. |
48 | Some git commands run `git gc --auto` after performing | |
b586a96a NTND |
49 | operations that could create many loose objects. Housekeeping |
50 | is required if there are too many loose objects or too many | |
51 | packs in the repository. | |
d7e56dbc | 52 | + |
b586a96a NTND |
53 | If the number of loose objects exceeds the value of the `gc.auto` |
54 | configuration variable, then all loose objects are combined into a | |
55 | single pack using `git repack -d -l`. Setting the value of `gc.auto` | |
56 | to 0 disables automatic packing of loose objects. | |
d7e56dbc | 57 | + |
da0005b8 | 58 | If the number of packs exceeds the value of `gc.autoPackLimit`, |
55dfe13d NTND |
59 | then existing packs (except those marked with a `.keep` file |
60 | or over `gc.bigPackThreshold` limit) | |
d7e56dbc | 61 | are consolidated into a single pack by using the `-A` option of |
9806f5a7 NTND |
62 | 'git repack'. |
63 | If the amount of memory is estimated not enough for `git repack` to | |
64 | run smoothly and `gc.bigPackThreshold` is not set, the largest | |
65 | pack will also be excluded (this is the equivalent of running `git gc` | |
66 | with `--keep-base-pack`). | |
67 | Setting `gc.autoPackLimit` to 0 disables automatic consolidation of | |
68 | packs. | |
b586a96a NTND |
69 | + |
70 | If houskeeping is required due to many loose objects or packs, all | |
71 | other housekeeping tasks (e.g. rerere, working trees, reflog...) will | |
72 | be performed as well. | |
73 | ||
e3ff4b24 | 74 | |
58e9d9d4 JS |
75 | --prune=<date>:: |
76 | Prune loose objects older than date (default is 2 weeks ago, | |
61929404 | 77 | overridable by the config variable `gc.pruneExpire`). |
f1350d0c MM |
78 | --prune=all prunes loose objects regardless of their age and |
79 | increases the risk of corruption if another process is writing to | |
80 | the repository concurrently; see "NOTES" below. --prune is on by | |
81 | default. | |
58e9d9d4 JS |
82 | |
83 | --no-prune:: | |
84 | Do not prune any loose objects. | |
85 | ||
a0c14cbb FL |
86 | --quiet:: |
87 | Suppress all progress reports. | |
88 | ||
64a99eb4 NTND |
89 | --force:: |
90 | Force `git gc` to run even if there may be another `git gc` | |
91 | instance running on this repository. | |
92 | ||
ae4e89e5 NTND |
93 | --keep-largest-pack:: |
94 | All packs except the largest pack and those marked with a | |
55dfe13d NTND |
95 | `.keep` files are consolidated into a single pack. When this |
96 | option is used, `gc.bigPackThreshold` is ignored. | |
ae4e89e5 | 97 | |
76a8788c | 98 | CONFIGURATION |
30f610b7 SP |
99 | ------------- |
100 | ||
ae9f6311 | 101 | The optional configuration variable `gc.reflogExpire` can be |
30f610b7 SP |
102 | set to indicate how long historical entries within each branch's |
103 | reflog should remain available in this repository. The setting is | |
104 | expressed as a length of time, for example '90 days' or '3 months'. | |
105 | It defaults to '90 days'. | |
106 | ||
ae9f6311 | 107 | The optional configuration variable `gc.reflogExpireUnreachable` |
30f610b7 SP |
108 | can be set to indicate how long historical reflog entries which |
109 | are not part of the current branch should remain available in | |
110 | this repository. These types of entries are generally created as | |
6cf378f0 | 111 | a result of using `git commit --amend` or `git rebase` and are the |
23bfbb81 | 112 | commits prior to the amend or rebase occurring. Since these changes |
30f610b7 SP |
113 | are not part of the current project most users will want to expire |
114 | them sooner. This option defaults to '30 days'. | |
115 | ||
eb523a8d | 116 | The above two configuration variables can be given to a pattern. For |
60109d0e | 117 | example, this sets non-default expiry values only to remote-tracking |
eb523a8d JH |
118 | branches: |
119 | ||
120 | ------------ | |
121 | [gc "refs/remotes/*"] | |
122 | reflogExpire = never | |
da0005b8 | 123 | reflogExpireUnreachable = 3 days |
eb523a8d JH |
124 | ------------ |
125 | ||
ae9f6311 | 126 | The optional configuration variable `gc.rerereResolved` indicates |
30f610b7 SP |
127 | how long records of conflicted merge you resolved earlier are |
128 | kept. This defaults to 60 days. | |
129 | ||
ae9f6311 | 130 | The optional configuration variable `gc.rerereUnresolved` indicates |
30f610b7 SP |
131 | how long records of conflicted merge you have not resolved are |
132 | kept. This defaults to 15 days. | |
133 | ||
ae9f6311 | 134 | The optional configuration variable `gc.packRefs` determines if |
4be0c352 | 135 | 'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable |
fe2128a8 FLR |
136 | it within all non-bare repos or it can be set to a boolean value. |
137 | This defaults to true. | |
30f610b7 | 138 | |
ae9f6311 | 139 | The optional configuration variable `gc.aggressiveWindow` controls how |
0d7566a5 TT |
140 | much time is spent optimizing the delta compression of the objects in |
141 | the repository when the --aggressive option is specified. The larger | |
142 | the value, the more time is spent optimizing the delta compression. See | |
bed21a8a | 143 | the documentation for the --window option in linkgit:git-repack[1] for |
c9486ae8 | 144 | more details. This defaults to 250. |
125f8146 | 145 | |
ae9f6311 | 146 | Similarly, the optional configuration variable `gc.aggressiveDepth` |
7e823880 | 147 | controls --depth option in linkgit:git-repack[1]. This defaults to 50. |
0d7566a5 | 148 | |
ae9f6311 | 149 | The optional configuration variable `gc.pruneExpire` controls how old |
25ee9731 JS |
150 | the unreferenced loose objects have to be before they are pruned. The |
151 | default is "2 weeks ago". | |
152 | ||
b586a96a NTND |
153 | Optional configuration variable `gc.worktreePruneExpire` controls how |
154 | old a stale working tree should be before `git worktree prune` deletes | |
155 | it. Default is "3 months ago". | |
156 | ||
3ffb58be | 157 | |
76a8788c | 158 | NOTES |
3ffb58be JK |
159 | ----- |
160 | ||
f1350d0c MM |
161 | 'git gc' tries very hard not to delete objects that are referenced |
162 | anywhere in your repository. In | |
3ffb58be | 163 | particular, it will keep not only objects referenced by your current set |
60109d0e MM |
164 | of branches and tags, but also objects referenced by the index, |
165 | remote-tracking branches, refs saved by 'git filter-branch' in | |
3ed0b11e | 166 | refs/original/, or reflogs (which may reference commits in branches |
3ffb58be | 167 | that were later amended or rewound). |
f1350d0c | 168 | If you are expecting some objects to be deleted and they aren't, check |
3ffb58be JK |
169 | all of those locations and decide whether it makes sense in your case to |
170 | remove those references. | |
171 | ||
f1350d0c MM |
172 | On the other hand, when 'git gc' runs concurrently with another process, |
173 | there is a risk of it deleting an object that the other process is using | |
174 | but hasn't created a reference to. This may just cause the other process | |
175 | to fail or may corrupt the repository if the other process later adds a | |
176 | reference to the deleted object. Git has two features that significantly | |
177 | mitigate this problem: | |
178 | ||
179 | . Any object with modification time newer than the `--prune` date is kept, | |
180 | along with everything reachable from it. | |
181 | ||
182 | . Most operations that add an object to the database update the | |
183 | modification time of the object if it is already present so that #1 | |
184 | applies. | |
185 | ||
186 | However, these features fall short of a complete solution, so users who | |
187 | run commands concurrently have to live with some risk of corruption (which | |
188 | seems to be low in practice) unless they turn off automatic garbage | |
189 | collection with 'git config gc.auto 0'. | |
190 | ||
66bd8ab8 CP |
191 | HOOKS |
192 | ----- | |
193 | ||
194 | The 'git gc --auto' command will run the 'pre-auto-gc' hook. See | |
195 | linkgit:githooks[5] for more information. | |
196 | ||
197 | ||
56ae8df5 | 198 | SEE ALSO |
30f610b7 | 199 | -------- |
5162e697 DM |
200 | linkgit:git-prune[1] |
201 | linkgit:git-reflog[1] | |
202 | linkgit:git-repack[1] | |
203 | linkgit:git-rerere[1] | |
30f610b7 | 204 | |
30f610b7 SP |
205 | GIT |
206 | --- | |
9e1f0a85 | 207 | Part of the linkgit:git[1] suite |