undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git-gc.txt, git-reflog.txt: document new expiry options

Browse Source 
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>
This commit is contained in:
Michael Haggerty 2013-04-18 09:46:34 +02:00 committed by Junio C Hamano
parent 3d27b9b005
commit 61929404df
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/git-gc.txt
View File

@ -62,8 +62,9 @@ automatic consolidation of packs.
--prune=<date>:: --prune=<date>::
Prune loose objects older than date (default is 2 weeks ago, Prune loose objects older than date (default is 2 weeks ago,
overridable by the config variable `gc.pruneExpire`). This overridable by the config variable `gc.pruneExpire`).
option is on by default. --prune=all prunes loose objects regardless of their age.
--prune is on by default.
--no-prune:: --no-prune::
Do not prune any loose objects. Do not prune any loose objects.

9
Documentation/git-reflog.txt
View File

@ -67,14 +67,19 @@ them.
--expire=<time>:: --expire=<time>::
Entries older than this time are pruned. Without the Entries older than this time are pruned. Without the
option it is taken from configuration `gc.reflogExpire`, 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>:: --expire-unreachable=<time>::
Entries older than this time and not reachable from Entries older than this time and not reachable from
the current tip of the branch are pruned. Without the the current tip of the branch are pruned. Without the
option it is taken from configuration option it is taken from configuration
`gc.reflogExpireUnreachable`, which in turn defaults to `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:: --all::
Instead of listing <refs> explicitly, prune all refs. Instead of listing <refs> explicitly, prune all refs.