i18n: git-am "Falling back" say message
[git.git] / Documentation / git-gc.txt
blob4966cb57846412b097bbc8ba15d09005f4019340
1 git-gc(1)
2 =========
4 NAME
5 ----
6 git-gc - Cleanup unnecessary files and optimize the local repository
9 SYNOPSIS
10 --------
11 'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune]
13 DESCRIPTION
14 -----------
15 Runs a number of housekeeping tasks within the current repository,
16 such as compressing file revisions (to reduce disk space and increase
17 performance) and removing unreachable objects which may have been
18 created from prior invocations of 'git add'.
20 Users are encouraged to run this task on a regular basis within
21 each repository to maintain good disk space utilization and good
22 operating performance.
24 Some git commands may automatically run 'git gc'; see the `--auto` flag
25 below for details. If you know what you're doing and all you want is to
26 disable this behavior permanently without further considerations, just do:
28 ----------------------
29 $ git config --global gc.auto 0
30 ----------------------
32 OPTIONS
33 -------
35 --aggressive::
36         Usually 'git gc' runs very quickly while providing good disk
37         space utilization and performance.  This option will cause
38         'git gc' to more aggressively optimize the repository at the expense
39         of taking much more time.  The effects of this optimization are
40         persistent, so this option only needs to be used occasionally; every
41         few hundred changesets or so.
43 --auto::
44         With this option, 'git gc' checks whether any housekeeping is
45         required; if not, it exits without performing any work.
46         Some git commands run `git gc --auto` after performing
47         operations that could create many loose objects.
49 Housekeeping is required if there are too many loose objects or
50 too many packs in the repository. If the number of loose objects
51 exceeds the value of the `gc.auto` configuration variable, then
52 all loose objects are combined into a single pack using
53 `git repack -d -l`.  Setting the value of `gc.auto` to 0
54 disables automatic packing of loose objects.
56 If the number of packs exceeds the value of `gc.autopacklimit`,
57 then existing packs (except those marked with a `.keep` file)
58 are consolidated into a single pack by using the `-A` option of
59 'git repack'. Setting `gc.autopacklimit` to 0 disables
60 automatic consolidation of packs.
62 --prune=<date>::
63         Prune loose objects older than date (default is 2 weeks ago,
64         overridable by the config variable `gc.pruneExpire`).  This
65         option is on by default.
67 --no-prune::
68         Do not prune any loose objects.
70 --quiet::
71         Suppress all progress reports.
73 Configuration
74 -------------
76 The optional configuration variable 'gc.reflogExpire' can be
77 set to indicate how long historical entries within each branch's
78 reflog should remain available in this repository.  The setting is
79 expressed as a length of time, for example '90 days' or '3 months'.
80 It defaults to '90 days'.
82 The optional configuration variable 'gc.reflogExpireUnreachable'
83 can be set to indicate how long historical reflog entries which
84 are not part of the current branch should remain available in
85 this repository.  These types of entries are generally created as
86 a result of using `git commit \--amend` or `git rebase` and are the
87 commits prior to the amend or rebase occurring.  Since these changes
88 are not part of the current project most users will want to expire
89 them sooner.  This option defaults to '30 days'.
91 The above two configuration variables can be given to a pattern.  For
92 example, this sets non-default expiry values only to remote-tracking
93 branches:
95 ------------
96 [gc "refs/remotes/*"]
97         reflogExpire = never
98         reflogexpireUnreachable = 3 days
99 ------------
101 The optional configuration variable 'gc.rerereresolved' indicates
102 how long records of conflicted merge you resolved earlier are
103 kept.  This defaults to 60 days.
105 The optional configuration variable 'gc.rerereunresolved' indicates
106 how long records of conflicted merge you have not resolved are
107 kept.  This defaults to 15 days.
109 The optional configuration variable 'gc.packrefs' determines if
110 'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable
111 it within all non-bare repos or it can be set to a boolean value.
112 This defaults to true.
114 The optional configuration variable 'gc.aggressiveWindow' controls how
115 much time is spent optimizing the delta compression of the objects in
116 the repository when the --aggressive option is specified.  The larger
117 the value, the more time is spent optimizing the delta compression.  See
118 the documentation for the --window' option in linkgit:git-repack[1] for
119 more details.  This defaults to 250.
121 The optional configuration variable 'gc.pruneExpire' controls how old
122 the unreferenced loose objects have to be before they are pruned.  The
123 default is "2 weeks ago".
126 Notes
127 -----
129 'git gc' tries very hard to be safe about the garbage it collects. In
130 particular, it will keep not only objects referenced by your current set
131 of branches and tags, but also objects referenced by the index,
132 remote-tracking branches, refs saved by 'git filter-branch' in
133 refs/original/, or reflogs (which may reference commits in branches
134 that were later amended or rewound).
136 If you are expecting some objects to be collected and they aren't, check
137 all of those locations and decide whether it makes sense in your case to
138 remove those references.
140 HOOKS
141 -----
143 The 'git gc --auto' command will run the 'pre-auto-gc' hook.  See
144 linkgit:githooks[5] for more information.
147 SEE ALSO
148 --------
149 linkgit:git-prune[1]
150 linkgit:git-reflog[1]
151 linkgit:git-repack[1]
152 linkgit:git-rerere[1]
156 Part of the linkgit:git[1] suite