Documentation/config/gc.txt

   1 gc.aggressiveDepth::
   2         The depth parameter used in the delta compression
   3         algorithm used by 'git gc --aggressive'.  This defaults
   4         to 50, which is the default for the `--depth` option when
   5         `--aggressive` isn't in use.
   6 +
   7 See the documentation for the `--depth` option in
   8 linkgit:git-repack[1] for more details.
   9
  10 gc.aggressiveWindow::
  11         The window size parameter used in the delta compression
  12         algorithm used by 'git gc --aggressive'.  This defaults
  13         to 250, which is a much more aggressive window size than
  14         the default `--window` of 10.
  15 +
  16 See the documentation for the `--window` option in
  17 linkgit:git-repack[1] for more details.
  18
  19 gc.auto::
  20         When there are approximately more than this many loose
  21         objects in the repository, `git gc --auto` will pack them.
  22         Some Porcelain commands use this command to perform a
  23         light-weight garbage collection from time to time.  The
  24         default value is 6700.
  25 +
  26 Setting this to 0 disables not only automatic packing based on the
  27 number of loose objects, but any other heuristic `git gc --auto` will
  28 otherwise use to determine if there's work to do, such as
  29 `gc.autoPackLimit`.
  30
  31 gc.autoPackLimit::
  32         When there are more than this many packs that are not
  33         marked with `*.keep` file in the repository, `git gc
  34         --auto` consolidates them into one larger pack.  The
  35         default value is 50.  Setting this to 0 disables it.
  36         Setting `gc.auto` to 0 will also disable this.
  37 +
  38 See the `gc.bigPackThreshold` configuration variable below. When in
  39 use, it'll affect how the auto pack limit works.
  40
  41 gc.autoDetach::
  42         Make `git gc --auto` return immediately and run in background
  43         if the system supports it. Default is true.
  44
  45 gc.bigPackThreshold::
  46         If non-zero, all packs larger than this limit are kept when
  47         `git gc` is run. This is very similar to `--keep-largest-pack`
  48         except that all packs that meet the threshold are kept, not
  49         just the largest pack. Defaults to zero. Common unit suffixes of
  50         'k', 'm', or 'g' are supported.
  51 +
  52 Note that if the number of kept packs is more than gc.autoPackLimit,
  53 this configuration variable is ignored, all packs except the base pack
  54 will be repacked. After this the number of packs should go below
  55 gc.autoPackLimit and gc.bigPackThreshold should be respected again.
  56 +
  57 If the amount of memory estimated for `git repack` to run smoothly is
  58 not available and `gc.bigPackThreshold` is not set, the largest pack
  59 will also be excluded (this is the equivalent of running `git gc` with
  60 `--keep-largest-pack`).
  61
  62 gc.writeCommitGraph::
  63         If true, then gc will rewrite the commit-graph file when
  64         linkgit:git-gc[1] is run. When using `git gc --auto`
  65         the commit-graph will be updated if housekeeping is
  66         required. Default is true. See linkgit:git-commit-graph[1]
  67         for details.
  68
  69 gc.logExpiry::
  70         If the file gc.log exists, then `git gc --auto` will print
  71         its content and exit with status zero instead of running
  72         unless that file is more than 'gc.logExpiry' old.  Default is
  73         "1.day".  See `gc.pruneExpire` for more ways to specify its
  74         value.
  75
  76 gc.packRefs::
  77         Running `git pack-refs` in a repository renders it
  78         unclonable by Git versions prior to 1.5.1.2 over dumb
  79         transports such as HTTP.  This variable determines whether
  80         'git gc' runs `git pack-refs`. This can be set to `notbare`
  81         to enable it within all non-bare repos or it can be set to a
  82         boolean value.  The default is `true`.
  83
  84 gc.cruftPacks::
  85         Store unreachable objects in a cruft pack (see
  86         linkgit:git-repack[1]) instead of as loose objects. The default
  87         is `false`.
  88
  89 gc.pruneExpire::
  90         When 'git gc' is run, it will call 'prune --expire 2.weeks.ago'
  91         (and 'repack --cruft --cruft-expiration 2.weeks.ago' if using
  92         cruft packs via `gc.cruftPacks` or `--cruft`).  Override the
  93         grace period with this config variable.  The value "now" may be
  94         used to disable this grace period and always prune unreachable
  95         objects immediately, or "never" may be used to suppress pruning.
  96         This feature helps prevent corruption when 'git gc' runs
  97         concurrently with another process writing to the repository; see
  98         the "NOTES" section of linkgit:git-gc[1].
  99
 100 gc.worktreePruneExpire::
 101         When 'git gc' is run, it calls
 102         'git worktree prune --expire 3.months.ago'.
 103         This config variable can be used to set a different grace
 104         period. The value "now" may be used to disable the grace
 105         period and prune `$GIT_DIR/worktrees` immediately, or "never"
 106         may be used to suppress pruning.
 107
 108 gc.reflogExpire::
 109 gc.<pattern>.reflogExpire::
 110         'git reflog expire' removes reflog entries older than
 111         this time; defaults to 90 days. The value "now" expires all
 112         entries immediately, and "never" suppresses expiration
 113         altogether. With "<pattern>" (e.g.
 114         "refs/stash") in the middle the setting applies only to
 115         the refs that match the <pattern>.
 116
 117 gc.reflogExpireUnreachable::
 118 gc.<pattern>.reflogExpireUnreachable::
 119         'git reflog expire' removes reflog entries older than
 120         this time and are not reachable from the current tip;
 121         defaults to 30 days. The value "now" expires all entries
 122         immediately, and "never" suppresses expiration altogether.
 123         With "<pattern>" (e.g. "refs/stash")
 124         in the middle, the setting applies only to the refs that
 125         match the <pattern>.
 126 +
 127 These types of entries are generally created as a result of using `git
 128 commit --amend` or `git rebase` and are the commits prior to the amend
 129 or rebase occurring.  Since these changes are not part of the current
 130 project most users will want to expire them sooner, which is why the
 131 default is more aggressive than `gc.reflogExpire`.
 132
 133 gc.rerereResolved::
 134         Records of conflicted merge you resolved earlier are
 135         kept for this many days when 'git rerere gc' is run.
 136         You can also use more human-readable "1.month.ago", etc.
 137         The default is 60 days.  See linkgit:git-rerere[1].
 138
 139 gc.rerereUnresolved::
 140         Records of conflicted merge you have not resolved are
 141         kept for this many days when 'git rerere gc' is run.
 142         You can also use more human-readable "1.month.ago", etc.
 143         The default is 15 days.  See linkgit:git-rerere[1].