Code

instaweb: support for Ruby's WEBrick server
[git.git] / Documentation / git-gc.txt
index 4ac839f938f9c2617c211dd829ba910577534558..b9d5660eacee03bde2360b97b80f3378972fe678 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
 -----------
@@ -37,12 +37,26 @@ 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 if there are too many
+       loose objects in the repository and runs
+       gitlink:git-repack[1] with `-d -l` option to pack them.
+       The threshold for loose objects is set with `gc.auto` configuration
+       variable, and can be disabled by setting it to 0.  Some
+       Porcelain commands use this after they perform operation
+       that could create many loose objects automatically.
+       Additionally, when there are too many packs are present,
+       they are consolidated into one larger pack by running
+       the `git-repack` command with `-A` option.  The
+       threshold for number of packs is set with
+       `gc.autopacklimit` configuration variable.
+
 Configuration
 -------------