diff options
| author |  Michael Haggerty <mhagger@alum.mit.edu> | 2013-04-18 09:46:34 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2013-04-18 09:30:15 -0700 |
| commit | 61929404df24325b8bebedbd70d55d21142de9dd (patch) | |
| tree | 0adc04621204abdb7d6bf8a55a281e41885c82c2 /Documentation | |
| parent | date.c: add parse_expiry_date() (diff) | |
| download | tgif-61929404df24325b8bebedbd70d55d21142de9dd.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/git-gc.txt | 5 | ||||
| -rw-r--r-- | Documentation/git-reflog.txt | 9 |
2 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index b370b025b8..2402ed6828 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -62,8 +62,9 @@ automatic consolidation of packs. --prune=<date>:: Prune loose objects older than date (default is 2 weeks ago, - overridable by the config variable `gc.pruneExpire`). This - option is on by default. + overridable by the config variable `gc.pruneExpire`). + --prune=all prunes loose objects regardless of their age. + --prune is on by default. --no-prune:: Do not prune any loose objects. diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index 7fe2d2247b..141e8a5e43 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -67,14 +67,19 @@ them. --expire=<time>:: Entries older than this time are pruned. Without the option it is taken from configuration `gc.reflogExpire`, - which in turn defaults to 90 days. + which in turn defaults to 90 days. --expire=all prunes + entries regardless of their age; --expire=never turns off + pruning of reachable entries (but see --expire-unreachable). --expire-unreachable=<time>:: Entries older than this time and not reachable from the current tip of the branch are pruned. Without the option it is taken from configuration `gc.reflogExpireUnreachable`, which in turn defaults to - 30 days. + 30 days. --expire-unreachable=all prunes unreachable + entries regardless of their age; --expire-unreachable=never + turns off early pruning of unreachable entries (but see + --expire). --all:: Instead of listing <refs> explicitly, prune all refs. |