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

gc.txt: more details about what gc does

Browse Source 
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Nguyễn Thái Ngọc Duy 2018-03-15 17:44:10 +01:00 committed by Junio C Hamano
parent 7e31236f65
commit b586a96a39
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/git-gc.txt
View File

@ -15,8 +15,9 @@ DESCRIPTION
----------- -----------
Runs a number of housekeeping tasks within the current repository, Runs a number of housekeeping tasks within the current repository,
such as compressing file revisions (to reduce disk space and increase such as compressing file revisions (to reduce disk space and increase
performance) and removing unreachable objects which may have been performance), removing unreachable objects which may have been
created from prior invocations of 'git add'. created from prior invocations of 'git add', packing refs, pruning
reflog, rerere metadata or stale working trees.
Users are encouraged to run this task on a regular basis within Users are encouraged to run this task on a regular basis within
each repository to maintain good disk space utilization and good each repository to maintain good disk space utilization and good
@ -45,20 +46,25 @@ OPTIONS
With this option, 'git gc' checks whether any housekeeping is With this option, 'git gc' checks whether any housekeeping is
required; if not, it exits without performing any work. required; if not, it exits without performing any work.
Some git commands run `git gc --auto` after performing Some git commands run `git gc --auto` after performing
operations that could create many loose objects. operations that could create many loose objects. Housekeeping
is required if there are too many loose objects or too many
packs in the repository.
+ +
Housekeeping is required if there are too many loose objects or If the number of loose objects exceeds the value of the `gc.auto`
too many packs in the repository. If the number of loose objects configuration variable, then all loose objects are combined into a
exceeds the value of the `gc.auto` configuration variable, then single pack using `git repack -d -l`. Setting the value of `gc.auto`
all loose objects are combined into a single pack using to 0 disables automatic packing of loose objects.
`git repack -d -l`. Setting the value of `gc.auto` to 0
disables automatic packing of loose objects.
+ +
If the number of packs exceeds the value of `gc.autoPackLimit`, If the number of packs exceeds the value of `gc.autoPackLimit`,
then existing packs (except those marked with a `.keep` file) then existing packs (except those marked with a `.keep` file)
are consolidated into a single pack by using the `-A` option of are consolidated into a single pack by using the `-A` option of
'git repack'. Setting `gc.autoPackLimit` to 0 disables 'git repack'. Setting `gc.autoPackLimit` to 0 disables
automatic consolidation of packs. automatic consolidation of packs.
+
If houskeeping is required due to many loose objects or packs, all
other housekeeping tasks (e.g. rerere, working trees, reflog...) will
be performed as well.
--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,
@ -133,6 +139,10 @@ The optional configuration variable `gc.pruneExpire` controls how old
the unreferenced loose objects have to be before they are pruned. The the unreferenced loose objects have to be before they are pruned. The
default is "2 weeks ago". default is "2 weeks ago".
Optional configuration variable `gc.worktreePruneExpire` controls how
old a stale working tree should be before `git worktree prune` deletes
it. Default is "3 months ago".
Notes Notes
----- -----