GIT 1.5.1.6

[git.git] / Documentation / git-gc.txt

diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 2bcc9491a3a985a62d86dc93d83b217f0220e3dc..bc1658434a61bdba41699859f103a3c8e0802d95 100644 (file)
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -8,7 +8,7 @@ git-gc - Cleanup unnecessary files and optimize the local repository
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-'git-gc'
+'git-gc' [--prune]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -21,6 +21,21 @@ Users are encouraged to run this task on a regular basis within
 each repository to maintain good disk space utilization and good
 operating performance.
 
 each repository to maintain good disk space utilization and good
 operating performance.
 

+OPTIONS
+-------
+
+--prune::
+       Usually `git-gc` packs refs, expires old reflog entries,
+       packs loose objects,
+       and removes old 'rerere' records.  Removal
+       of unreferenced loose objects is an unsafe operation
+       while other git operations are in progress, so it is not
+       done by default.  Pass this option if you want it, and only
+       when you know nobody else is creating new objects in the
+       repository at the same time (e.g. never use this option
+       in a cron script).
+
+

 Configuration
 -------------
 
 Configuration
 -------------
 


@@ -47,6 +62,10 @@ The optional configuration variable 'gc.rerereunresolved' indicates
 how long records of conflicted merge you have not resolved are
 kept.  This defaults to 15 days.
 
 how long records of conflicted merge you have not resolved are
 kept.  This defaults to 15 days.
 

+The optional configuration variable 'gc.packrefs' determines if
+`git gc` runs `git-pack-refs`.  Without the configuration, `git-pack-refs`
+is not run in bare repositories by default, to allow older dumb-transport
+clients fetch from the repository,  but this will change in the future.

 
 See Also
 --------
 
 See Also
 --------