@matheusbsbs / matheus-bagliano / commits / d7e56dbc4f
Fork 0

Documentation/git-gc: improve description of --auto

This patch tries to make the description of --auto a little more clear for new users, especially those referred by the "git-gc --auto" notification message. It also cleans up some grammatical errors and typos in the original description, as well as rewording for clarity. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Shawn O. Pearce <spearce@spearce.org>

Jeff King committed Oct 18, 2007 at 22:05 UTC d7e56dbc4f60f6bd238e8612783541d89f006fb7
1 file changed +17 -12
Documentation/git-gc.txt
+17 -12
@@ -45,18 +45,23 @@ OPTIONS
45 few hundred changesets or so.
46
47 --auto::
48 - With this option, `git gc` checks if there are too many
49 - loose objects in the repository and runs
50 - gitlink:git-repack[1] with `-d -l` option to pack them.
51 - The threshold for loose objects is set with `gc.auto` configuration
52 - variable, and can be disabled by setting it to 0. Some
53 - Porcelain commands use this after they perform operation
54 - that could create many loose objects automatically.
55 - Additionally, when there are too many packs are present,
56 - they are consolidated into one larger pack by running
57 - the `git-repack` command with `-A` option. The
58 - threshold for number of packs is set with
59 - `gc.autopacklimit` configuration variable.
48 + With this option, `git gc` checks whether any housekeeping is
49 + required; if not, it exits without performing any work.
50 + Some git commands run `git gc --auto` after performing
51 + operations that could create many loose objects.
52 ++
53 +Housekeeping is required if there are too many loose objects or
54 +too many packs in the repository. If the number of loose objects
55 +exceeds the value of the `gc.auto` configuration variable, then
56 +all loose objects are combined into a single pack using
57 +`git-repack -d -l`. Setting the value of `gc.auto` to 0
58 +disables automatic packing of loose objects.
59 ++
60 +If the number of packs exceeds the value of `gc.autopacklimit`,
61 +then existing packs (except those marked with a `.keep` file)
62 +are consolidated into a single pack by using the `-A` option of
63 +`git-repack`. Setting `gc.autopacklimit` to 0 disables
64 +automatic consolidation of packs.
65
66 Configuration
67 -------------