Documentation/git-gc.txt

   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 --------
  11 [verse]
  12 'git gc' [--aggressive] [--auto] [--[no-]detach] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack]
  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), 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. May also update ancillary
  21 indexes such as the commit-graph.
  22
  23 When common porcelain operations that create objects are run, they
  24 will check whether the repository has grown substantially since the
  25 last maintenance, and if so run `git gc` automatically. See `gc.auto`
  26 below for how to disable this behavior.
  27
  28 Running `git gc` manually should only be needed when adding objects to
  29 a repository without regularly running such porcelain commands, to do
  30 a one-off repository optimization, or e.g. to clean up a suboptimal
  31 mass-import. See the "PACKFILE OPTIMIZATION" section in
  32 linkgit:git-fast-import[1] for more details on the import case.
  33
  34 OPTIONS
  35 -------
  36
  37 --aggressive::
  38         Usually 'git gc' runs very quickly while providing good disk
  39         space utilization and performance.  This option will cause
  40         'git gc' to more aggressively optimize the repository at the expense
  41         of taking much more time.  The effects of this optimization are
  42         mostly persistent. See the "AGGRESSIVE" section below for details.
  43
  44 --auto::
  45         With this option, 'git gc' checks whether any housekeeping is
  46         required; if not, it exits without performing any work.
  47 +
  48 See the `gc.auto` option in the "CONFIGURATION" section below for how
  49 this heuristic works.
  50 +
  51 Once housekeeping is triggered by exceeding the limits of
  52 configuration options such as `gc.auto` and `gc.autoPackLimit`, all
  53 other housekeeping tasks (e.g. rerere, working trees, reflog...) will
  54 be performed as well.
  55
  56 --[no-]detach::
  57         Run in the background if the system supports it. This option overrides
  58         the `gc.autoDetach` config.
  59
  60 --[no-]cruft::
  61         When expiring unreachable objects, pack them separately into a
  62         cruft pack instead of storing them as loose objects. `--cruft`
  63         is on by default.
  64
  65 --max-cruft-size=<n>::
  66         When packing unreachable objects into a cruft pack, limit the
  67         size of new cruft packs to be at most `<n>` bytes. Overrides any
  68         value specified via the `gc.maxCruftSize` configuration. See
  69         the `--max-cruft-size` option of linkgit:git-repack[1] for
  70         more.
  71
  72 --prune=<date>::
  73         Prune loose objects older than date (default is 2 weeks ago,
  74         overridable by the config variable `gc.pruneExpire`).
  75         --prune=now prunes loose objects regardless of their age and
  76         increases the risk of corruption if another process is writing to
  77         the repository concurrently; see "NOTES" below. --prune is on by
  78         default.
  79
  80 --no-prune::
  81         Do not prune any loose objects.
  82
  83 --quiet::
  84         Suppress all progress reports.
  85
  86 --force::
  87         Force `git gc` to run even if there may be another `git gc`
  88         instance running on this repository.
  89
  90 --keep-largest-pack::
  91         All packs except the largest non-cruft pack, any packs marked
  92         with a `.keep` file, and any cruft pack(s) are consolidated into
  93         a single pack. When this option is used, `gc.bigPackThreshold`
  94         is ignored.
  95
  96 AGGRESSIVE
  97 ----------
  98
  99 When the `--aggressive` option is supplied, linkgit:git-repack[1] will
 100 be invoked with the `-f` flag, which in turn will pass
 101 `--no-reuse-delta` to linkgit:git-pack-objects[1]. This will throw
 102 away any existing deltas and re-compute them, at the expense of
 103 spending much more time on the repacking.
 104
 105 The effects of this are mostly persistent, e.g. when packs and loose
 106 objects are coalesced into one another pack the existing deltas in
 107 that pack might get re-used, but there are also various cases where we
 108 might pick a sub-optimal delta from a newer pack instead.
 109
 110 Furthermore, supplying `--aggressive` will tweak the `--depth` and
 111 `--window` options passed to linkgit:git-repack[1]. See the
 112 `gc.aggressiveDepth` and `gc.aggressiveWindow` settings below. By
 113 using a larger window size we're more likely to find more optimal
 114 deltas.
 115
 116 It's probably not worth it to use this option on a given repository
 117 without running tailored performance benchmarks on it. It takes a lot
 118 more time, and the resulting space/delta optimization may or may not
 119 be worth it. Not using this at all is the right trade-off for most
 120 users and their repositories.
 121
 122 CONFIGURATION
 123 -------------
 124
 125 include::includes/cmd-config-section-all.txt[]
 126
 127 include::config/gc.txt[]
 128
 129 NOTES
 130 -----
 131
 132 'git gc' tries very hard not to delete objects that are referenced
 133 anywhere in your repository. In particular, it will keep not only
 134 objects referenced by your current set of branches and tags, but also
 135 objects referenced by the index, remote-tracking branches, reflogs
 136 (which may reference commits in branches that were later amended or
 137 rewound), and anything else in the refs/* namespace. Note that a note
 138 (of the kind created by 'git notes') attached to an object does not
 139 contribute in keeping the object alive. If you are expecting some
 140 objects to be deleted and they aren't, check all of those locations
 141 and decide whether it makes sense in your case to remove those
 142 references.
 143
 144 On the other hand, when 'git gc' runs concurrently with another process,
 145 there is a risk of it deleting an object that the other process is using
 146 but hasn't created a reference to. This may just cause the other process
 147 to fail or may corrupt the repository if the other process later adds a
 148 reference to the deleted object. Git has two features that significantly
 149 mitigate this problem:
 150
 151 . Any object with modification time newer than the `--prune` date is kept,
 152   along with everything reachable from it.
 153
 154 . Most operations that add an object to the database update the
 155   modification time of the object if it is already present so that #1
 156   applies.
 157
 158 However, these features fall short of a complete solution, so users who
 159 run commands concurrently have to live with some risk of corruption (which
 160 seems to be low in practice).
 161
 162 HOOKS
 163 -----
 164
 165 The 'git gc --auto' command will run the 'pre-auto-gc' hook.  See
 166 linkgit:githooks[5] for more information.
 167
 168
 169 SEE ALSO
 170 --------
 171 linkgit:git-prune[1]
 172 linkgit:git-reflog[1]
 173 linkgit:git-repack[1]
 174 linkgit:git-rerere[1]
 175
 176 GIT
 177 ---
 178 Part of the linkgit:git[1] suite