diff options
| author | Junio C Hamano <junkio@cox.net> | 2007-01-21 23:28:28 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2007-01-21 23:28:28 -0800 |
| commit | e3ff4b244726f89620201e3295f097cf00b6b502 (patch) | |
| tree | 0974a068a5c3ce28d9c132ec232ff8da266beded /Documentation/git-gc.txt | |
| parent | a0022eebf345a4515c7d148c303911010b1fa834 (diff) | |
| download | git-e3ff4b244726f89620201e3295f097cf00b6b502.tar.gz | |
git-gc: do not run git-prune by default.
git-prune is not safe when run uncontrolled in parallel while
other git operations are creating new objects. To avoid
mistakes, do not run git-prune by default from git-gc.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-gc.txt')
| -rw-r--r-- | Documentation/git-gc.txt | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 2bcc9491a3..e37758ad15 100644 --- 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 ------------- |