git-gc.txt, git-reflog.txt: document new expiry options
Document the new values that can be used for expiry values where their use makes sense: * git reflog expire --expire=[all|never] * git reflog expire --expire-unreachable=[all|never] * git gc --prune=all Other combinations aren't useful and therefore no documentation is added (even though they are allowed): * git gc --prune=never is redundant with "git gc --no-prune" * git prune --expire=all is equivalent to providing no --expire option * git prune --expire=never is a NOP Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael Haggerty committed
Apr 18, 2013 at 09:46 UTC
61929404df24325b8bebedbd70d55d21142de9dd
2 files changed
+10
-4
Documentation/git-gc.txt
+3
-2
@@ -62,8 +62,9 @@ automatic consolidation of packs.
62
63
--prune=<date>::
64
Prune loose objects older than date (default is 2 weeks ago,
65
- overridable by the config variable `gc.pruneExpire`). This
66
- option is on by default.
65
+ overridable by the config variable `gc.pruneExpire`).
66
+ --prune=all prunes loose objects regardless of their age.
67
+ --prune is on by default.
68
69
--no-prune::
70
Do not prune any loose objects.
Documentation/git-reflog.txt
+7
-2
@@ -67,14 +67,19 @@ them.
67
--expire=<time>::
68
Entries older than this time are pruned. Without the
69
option it is taken from configuration `gc.reflogExpire`,
70
- which in turn defaults to 90 days.
70
+ which in turn defaults to 90 days. --expire=all prunes
71
+ entries regardless of their age; --expire=never turns off
72
+ pruning of reachable entries (but see --expire-unreachable).
73
74
--expire-unreachable=<time>::
75
Entries older than this time and not reachable from
76
the current tip of the branch are pruned. Without the
77
option it is taken from configuration
78
`gc.reflogExpireUnreachable`, which in turn defaults to
77
- 30 days.
79
+ 30 days. --expire-unreachable=all prunes unreachable
80
+ entries regardless of their age; --expire-unreachable=never
81
+ turns off early pruning of unreachable entries (but see
82
+ --expire).
83
84
--all::
85
Instead of listing <refs> explicitly, prune all refs.