]>
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] |
64a99eb4 | 12 | 'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force] |
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 | |
18 | performance) and removing unreachable objects which may have been | |
0b444cdb | 19 | created from prior invocations of 'git add'. |
30f610b7 SP |
20 | |
21 | Users are encouraged to run this task on a regular basis within | |
22 | each repository to maintain good disk space utilization and good | |
05f30452 NP |
23 | operating performance. |
24 | ||
0b444cdb | 25 | Some git commands may automatically run 'git gc'; see the `--auto` flag |
05f30452 NP |
26 | below for details. If you know what you're doing and all you want is to |
27 | disable this behavior permanently without further considerations, just do: | |
28 | ||
29 | ---------------------- | |
30 | $ git config --global gc.auto 0 | |
31 | ---------------------- | |
30f610b7 | 32 | |
e3ff4b24 JH |
33 | OPTIONS |
34 | ------- | |
35 | ||
0d7566a5 | 36 | --aggressive:: |
0b444cdb | 37 | Usually 'git gc' runs very quickly while providing good disk |
5049012f | 38 | space utilization and performance. This option will cause |
0b444cdb | 39 | 'git gc' to more aggressively optimize the repository at the expense |
0d7566a5 | 40 | of taking much more time. The effects of this optimization are |
5049012f | 41 | persistent, so this option only needs to be used occasionally; every |
0d7566a5 | 42 | few hundred changesets or so. |
e9831e83 JH |
43 | |
44 | --auto:: | |
0b444cdb | 45 | With this option, 'git gc' checks whether any housekeeping is |
d7e56dbc JK |
46 | required; if not, it exits without performing any work. |
47 | Some git commands run `git gc --auto` after performing | |
48 | operations that could create many loose objects. | |
49 | + | |
50 | Housekeeping is required if there are too many loose objects or | |
51 | too many packs in the repository. If the number of loose objects | |
52 | exceeds the value of the `gc.auto` configuration variable, then | |
53 | all loose objects are combined into a single pack using | |
0b444cdb | 54 | `git repack -d -l`. Setting the value of `gc.auto` to 0 |
d7e56dbc JK |
55 | disables automatic packing of loose objects. |
56 | + | |
57 | If the number of packs exceeds the value of `gc.autopacklimit`, | |
58 | then existing packs (except those marked with a `.keep` file) | |
59 | are consolidated into a single pack by using the `-A` option of | |
0b444cdb | 60 | 'git repack'. Setting `gc.autopacklimit` to 0 disables |
d7e56dbc | 61 | automatic consolidation of packs. |
e3ff4b24 | 62 | |
58e9d9d4 JS |
63 | --prune=<date>:: |
64 | Prune loose objects older than date (default is 2 weeks ago, | |
61929404 MH |
65 | overridable by the config variable `gc.pruneExpire`). |
66 | --prune=all prunes loose objects regardless of their age. | |
67 | --prune is on by default. | |
58e9d9d4 JS |
68 | |
69 | --no-prune:: | |
70 | Do not prune any loose objects. | |
71 | ||
a0c14cbb FL |
72 | --quiet:: |
73 | Suppress all progress reports. | |
74 | ||
64a99eb4 NTND |
75 | --force:: |
76 | Force `git gc` to run even if there may be another `git gc` | |
77 | instance running on this repository. | |
78 | ||
30f610b7 SP |
79 | Configuration |
80 | ------------- | |
81 | ||
82 | The optional configuration variable 'gc.reflogExpire' can be | |
83 | set to indicate how long historical entries within each branch's | |
84 | reflog should remain available in this repository. The setting is | |
85 | expressed as a length of time, for example '90 days' or '3 months'. | |
86 | It defaults to '90 days'. | |
87 | ||
88 | The optional configuration variable 'gc.reflogExpireUnreachable' | |
89 | can be set to indicate how long historical reflog entries which | |
90 | are not part of the current branch should remain available in | |
91 | this repository. These types of entries are generally created as | |
6cf378f0 | 92 | a result of using `git commit --amend` or `git rebase` and are the |
23bfbb81 | 93 | commits prior to the amend or rebase occurring. Since these changes |
30f610b7 SP |
94 | are not part of the current project most users will want to expire |
95 | them sooner. This option defaults to '30 days'. | |
96 | ||
eb523a8d | 97 | The above two configuration variables can be given to a pattern. For |
60109d0e | 98 | example, this sets non-default expiry values only to remote-tracking |
eb523a8d JH |
99 | branches: |
100 | ||
101 | ------------ | |
102 | [gc "refs/remotes/*"] | |
103 | reflogExpire = never | |
104 | reflogexpireUnreachable = 3 days | |
105 | ------------ | |
106 | ||
30f610b7 SP |
107 | The optional configuration variable 'gc.rerereresolved' indicates |
108 | how long records of conflicted merge you resolved earlier are | |
109 | kept. This defaults to 60 days. | |
110 | ||
111 | The optional configuration variable 'gc.rerereunresolved' indicates | |
112 | how long records of conflicted merge you have not resolved are | |
113 | kept. This defaults to 15 days. | |
114 | ||
c2120e5e | 115 | The optional configuration variable 'gc.packrefs' determines if |
4be0c352 | 116 | 'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable |
fe2128a8 FLR |
117 | it within all non-bare repos or it can be set to a boolean value. |
118 | This defaults to true. | |
30f610b7 | 119 | |
0d7566a5 TT |
120 | The optional configuration variable 'gc.aggressiveWindow' controls how |
121 | much time is spent optimizing the delta compression of the objects in | |
122 | the repository when the --aggressive option is specified. The larger | |
123 | the value, the more time is spent optimizing the delta compression. See | |
5162e697 | 124 | the documentation for the --window' option in linkgit:git-repack[1] for |
c9486ae8 | 125 | more details. This defaults to 250. |
125f8146 NTND |
126 | |
127 | Similarly, the optional configuration variable 'gc.aggressiveDepth' | |
128 | controls --depth option in linkgit:git-repack[1]. This defaults to 250. | |
0d7566a5 | 129 | |
25ee9731 JS |
130 | The optional configuration variable 'gc.pruneExpire' controls how old |
131 | the unreferenced loose objects have to be before they are pruned. The | |
132 | default is "2 weeks ago". | |
133 | ||
3ffb58be JK |
134 | |
135 | Notes | |
136 | ----- | |
137 | ||
0b444cdb | 138 | 'git gc' tries very hard to be safe about the garbage it collects. In |
3ffb58be | 139 | particular, it will keep not only objects referenced by your current set |
60109d0e MM |
140 | of branches and tags, but also objects referenced by the index, |
141 | remote-tracking branches, refs saved by 'git filter-branch' in | |
3ed0b11e | 142 | refs/original/, or reflogs (which may reference commits in branches |
3ffb58be JK |
143 | that were later amended or rewound). |
144 | ||
145 | If you are expecting some objects to be collected and they aren't, check | |
146 | all of those locations and decide whether it makes sense in your case to | |
147 | remove those references. | |
148 | ||
66bd8ab8 CP |
149 | HOOKS |
150 | ----- | |
151 | ||
152 | The 'git gc --auto' command will run the 'pre-auto-gc' hook. See | |
153 | linkgit:githooks[5] for more information. | |
154 | ||
155 | ||
56ae8df5 | 156 | SEE ALSO |
30f610b7 | 157 | -------- |
5162e697 DM |
158 | linkgit:git-prune[1] |
159 | linkgit:git-reflog[1] | |
160 | linkgit:git-repack[1] | |
161 | linkgit:git-rerere[1] | |
30f610b7 | 162 | |
30f610b7 SP |
163 | GIT |
164 | --- | |
9e1f0a85 | 165 | Part of the linkgit:git[1] suite |