summaryrefslogtreecommitdiff
path: root/Documentation/git-gc.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-10-14 20:48:39 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-10-14 20:48:39 (GMT)
commitfae1a901ec1811a325c6ccf7acac281e615478f0 (patch)
treeec33639aea9d22d4526cc5e3c4d2ecdc5b2268d7 /Documentation/git-gc.txt
parent441c4a40173fe1ee8a5c0094e587dfc47e2a6460 (diff)
downloadgit-fae1a901ec1811a325c6ccf7acac281e615478f0.zip
git-fae1a901ec1811a325c6ccf7acac281e615478f0.tar.gz
git-fae1a901ec1811a325c6ccf7acac281e615478f0.tar.bz2
Documentation/gc: warn against --prune=<now>
"git gc" is safe to run anytime only because it has the built-in grace period to protect objects that are created by other processes that are waiting for ref updates to anchor them to the history. In order to run with no grace period, the user must make sure that the repository is quiescent. Reviewed-by: Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-gc.txt')
-rw-r--r--Documentation/git-gc.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 273c466..6692fa7 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -63,8 +63,11 @@ automatic consolidation of packs.
--prune=<date>::
Prune loose objects older than date (default is 2 weeks ago,
overridable by the config variable `gc.pruneExpire`).
- --prune=all prunes loose objects regardless of their age.
- --prune is on by default.
+ --prune=all prunes loose objects regardless of their age (do
+ not use --prune=all unless you know exactly what you are doing.
+ Unless the repository is quiescent, you will lose newly created
+ objects that haven't been anchored with the refs and end up
+ corrupting your repository). --prune is on by default.
--no-prune::
Do not prune any loose objects.