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