Merge branch 'mh/work-tree'
[gitweb.git] / Documentation / git-gc.txt
index 4ac839f938f9c2617c211dd829ba910577534558..872056ea040f1f4953b538aaa4a14ded4d2170a9 100644 (file)
@@ -8,7 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository
 
 SYNOPSIS
 --------
-'git-gc' [--prune] [--aggressive]
+'git-gc' [--prune] [--aggressive] [--auto]
 
 DESCRIPTION
 -----------
@@ -19,7 +19,8 @@ created from prior invocations of gitlink:git-add[1].
 
 Users are encouraged to run this task on a regular basis within
 each repository to maintain good disk space utilization and good
-operating performance.
+operating performance. Some git commands may automatically run
+`git-gc`; see the `--auto` flag below for details.
 
 OPTIONS
 -------
@@ -37,12 +38,31 @@ OPTIONS
 
 --aggressive::
        Usually 'git-gc' runs very quickly while providing good disk
-       space utilization and performance.   This option will cause
-       git-gc to more aggressive optimize the repository at the expense
+       space utilization and performance.  This option will cause
+       git-gc to more aggressively optimize the repository at the expense
        of taking much more time.  The effects of this optimization are
-       persistent, so this option only needs to be sporadically; every
+       persistent, so this option only needs to be used occasionally; every
        few hundred changesets or so.
 
+--auto::
+       With this option, `git gc` checks whether any housekeeping is
+       required; if not, it exits without performing any work.
+       Some git commands run `git gc --auto` after performing
+       operations that could create many loose objects.
++
+Housekeeping is required if there are too many loose objects or
+too many packs in the repository. If the number of loose objects
+exceeds the value of the `gc.auto` configuration variable, then
+all loose objects are combined into a single pack using
+`git-repack -d -l`.  Setting the value of `gc.auto` to 0
+disables automatic packing of loose objects.
++
+If the number of packs exceeds the value of `gc.autopacklimit`,
+then existing packs (except those marked with a `.keep` file)
+are consolidated into a single pack by using the `-A` option of
+`git-repack`. Setting `gc.autopacklimit` to 0 disables
+automatic consolidation of packs.
+
 Configuration
 -------------