doc: describe git svn init --ignore-refs
[git/git-svn.git] / Documentation / git-gc.txt
blob571b5a7e3c9dbc11aafc194b6e08dbbed5b2f7d3
1 git-gc(1)
2 =========
4 NAME
5 ----
6 git-gc - Cleanup unnecessary files and optimize the local repository
9 SYNOPSIS
10 --------
11 [verse]
12 'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force]
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
19 created from prior invocations of 'git add'.
21 Users are encouraged to run this task on a regular basis within
22 each repository to maintain good disk space utilization and good
23 operating performance.
25 Some git commands may automatically run 'git gc'; see the `--auto` flag
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:
29 ----------------------
30 $ git config --global gc.auto 0
31 ----------------------
33 OPTIONS
34 -------
36 --aggressive::
37         Usually 'git gc' runs very quickly while providing good disk
38         space utilization and performance.  This option will cause
39         'git gc' to more aggressively optimize the repository at the expense
40         of taking much more time.  The effects of this optimization are
41         persistent, so this option only needs to be used occasionally; every
42         few hundred changesets or so.
44 --auto::
45         With this option, 'git gc' checks whether any housekeeping is
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.
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
54 `git repack -d -l`.  Setting the value of `gc.auto` to 0
55 disables automatic packing of loose objects.
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
60 'git repack'. Setting `gc.autoPackLimit` to 0 disables
61 automatic consolidation of packs.
63 --prune=<date>::
64         Prune loose objects older than date (default is 2 weeks ago,
65         overridable by the config variable `gc.pruneExpire`).
66         --prune=all prunes loose objects regardless of their age and
67         increases the risk of corruption if another process is writing to
68         the repository concurrently; see "NOTES" below. --prune is on by
69         default.
71 --no-prune::
72         Do not prune any loose objects.
74 --quiet::
75         Suppress all progress reports.
77 --force::
78         Force `git gc` to run even if there may be another `git gc`
79         instance running on this repository.
81 Configuration
82 -------------
84 The optional configuration variable `gc.reflogExpire` can be
85 set to indicate how long historical entries within each branch's
86 reflog should remain available in this repository.  The setting is
87 expressed as a length of time, for example '90 days' or '3 months'.
88 It defaults to '90 days'.
90 The optional configuration variable `gc.reflogExpireUnreachable`
91 can be set to indicate how long historical reflog entries which
92 are not part of the current branch should remain available in
93 this repository.  These types of entries are generally created as
94 a result of using `git commit --amend` or `git rebase` and are the
95 commits prior to the amend or rebase occurring.  Since these changes
96 are not part of the current project most users will want to expire
97 them sooner.  This option defaults to '30 days'.
99 The above two configuration variables can be given to a pattern.  For
100 example, this sets non-default expiry values only to remote-tracking
101 branches:
103 ------------
104 [gc "refs/remotes/*"]
105         reflogExpire = never
106         reflogExpireUnreachable = 3 days
107 ------------
109 The optional configuration variable `gc.rerereResolved` indicates
110 how long records of conflicted merge you resolved earlier are
111 kept.  This defaults to 60 days.
113 The optional configuration variable `gc.rerereUnresolved` indicates
114 how long records of conflicted merge you have not resolved are
115 kept.  This defaults to 15 days.
117 The optional configuration variable `gc.packRefs` determines if
118 'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable
119 it within all non-bare repos or it can be set to a boolean value.
120 This defaults to true.
122 The optional configuration variable `gc.aggressiveWindow` controls how
123 much time is spent optimizing the delta compression of the objects in
124 the repository when the --aggressive option is specified.  The larger
125 the value, the more time is spent optimizing the delta compression.  See
126 the documentation for the --window' option in linkgit:git-repack[1] for
127 more details.  This defaults to 250.
129 Similarly, the optional configuration variable `gc.aggressiveDepth`
130 controls --depth option in linkgit:git-repack[1]. This defaults to 50.
132 The optional configuration variable `gc.pruneExpire` controls how old
133 the unreferenced loose objects have to be before they are pruned.  The
134 default is "2 weeks ago".
137 Notes
138 -----
140 'git gc' tries very hard not to delete objects that are referenced
141 anywhere in your repository. In
142 particular, it will keep not only objects referenced by your current set
143 of branches and tags, but also objects referenced by the index,
144 remote-tracking branches, refs saved by 'git filter-branch' in
145 refs/original/, or reflogs (which may reference commits in branches
146 that were later amended or rewound).
147 If you are expecting some objects to be deleted and they aren't, check
148 all of those locations and decide whether it makes sense in your case to
149 remove those references.
151 On the other hand, when 'git gc' runs concurrently with another process,
152 there is a risk of it deleting an object that the other process is using
153 but hasn't created a reference to. This may just cause the other process
154 to fail or may corrupt the repository if the other process later adds a
155 reference to the deleted object. Git has two features that significantly
156 mitigate this problem:
158 . Any object with modification time newer than the `--prune` date is kept,
159   along with everything reachable from it.
161 . Most operations that add an object to the database update the
162   modification time of the object if it is already present so that #1
163   applies.
165 However, these features fall short of a complete solution, so users who
166 run commands concurrently have to live with some risk of corruption (which
167 seems to be low in practice) unless they turn off automatic garbage
168 collection with 'git config gc.auto 0'.
170 HOOKS
171 -----
173 The 'git gc --auto' command will run the 'pre-auto-gc' hook.  See
174 linkgit:githooks[5] for more information.
177 SEE ALSO
178 --------
179 linkgit:git-prune[1]
180 linkgit:git-reflog[1]
181 linkgit:git-repack[1]
182 linkgit:git-rerere[1]
186 Part of the linkgit:git[1] suite