reflog inspection: introduce shortcut "-g"

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

diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 2bcc9491a3a985a62d86dc93d83b217f0220e3dc..e37758ad15823c81d18ccc06fa4dc8775744cdcd 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
 --------
-'git-gc'
+'git-gc' [--prune]
 
 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.
 
+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
 -------------