Code

Fix some typos, punctuation, missing words, minor markup.
[git.git] / Documentation / git-gc.txt
index c7742ca9630b13d1eeef16d175f8ca840ddff4b0..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
 -----------
@@ -43,6 +43,20 @@ OPTIONS
        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
 -------------