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