i18n: grep: mark parseopt strings for translation
[git/jnareb-git.git] / Documentation / git-gc.txt
blobb370b025b89ffad0664171a03527b9a775172dee
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]
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`).  This
66         option is on by default.
68 --no-prune::
69         Do not prune any loose objects.
71 --quiet::
72         Suppress all progress reports.
74 Configuration
75 -------------
77 The optional configuration variable 'gc.reflogExpire' can be
78 set to indicate how long historical entries within each branch's
79 reflog should remain available in this repository.  The setting is
80 expressed as a length of time, for example '90 days' or '3 months'.
81 It defaults to '90 days'.
83 The optional configuration variable 'gc.reflogExpireUnreachable'
84 can be set to indicate how long historical reflog entries which
85 are not part of the current branch should remain available in
86 this repository.  These types of entries are generally created as
87 a result of using `git commit --amend` or `git rebase` and are the
88 commits prior to the amend or rebase occurring.  Since these changes
89 are not part of the current project most users will want to expire
90 them sooner.  This option defaults to '30 days'.
92 The above two configuration variables can be given to a pattern.  For
93 example, this sets non-default expiry values only to remote-tracking
94 branches:
96 ------------
97 [gc "refs/remotes/*"]
98         reflogExpire = never
99         reflogexpireUnreachable = 3 days
100 ------------
102 The optional configuration variable 'gc.rerereresolved' indicates
103 how long records of conflicted merge you resolved earlier are
104 kept.  This defaults to 60 days.
106 The optional configuration variable 'gc.rerereunresolved' indicates
107 how long records of conflicted merge you have not resolved are
108 kept.  This defaults to 15 days.
110 The optional configuration variable 'gc.packrefs' determines if
111 'git gc' runs 'git pack-refs'. This can be set to "notbare" to enable
112 it within all non-bare repos or it can be set to a boolean value.
113 This defaults to true.
115 The optional configuration variable 'gc.aggressiveWindow' controls how
116 much time is spent optimizing the delta compression of the objects in
117 the repository when the --aggressive option is specified.  The larger
118 the value, the more time is spent optimizing the delta compression.  See
119 the documentation for the --window' option in linkgit:git-repack[1] for
120 more details.  This defaults to 250.
122 The optional configuration variable 'gc.pruneExpire' controls how old
123 the unreferenced loose objects have to be before they are pruned.  The
124 default is "2 weeks ago".
127 Notes
128 -----
130 'git gc' tries very hard to be safe about the garbage it collects. In
131 particular, it will keep not only objects referenced by your current set
132 of branches and tags, but also objects referenced by the index,
133 remote-tracking branches, refs saved by 'git filter-branch' in
134 refs/original/, or reflogs (which may reference commits in branches
135 that were later amended or rewound).
137 If you are expecting some objects to be collected and they aren't, check
138 all of those locations and decide whether it makes sense in your case to
139 remove those references.
141 HOOKS
142 -----
144 The 'git gc --auto' command will run the 'pre-auto-gc' hook.  See
145 linkgit:githooks[5] for more information.
148 SEE ALSO
149 --------
150 linkgit:git-prune[1]
151 linkgit:git-reflog[1]
152 linkgit:git-repack[1]
153 linkgit:git-rerere[1]
157 Part of the linkgit:git[1] suite