From 30f610b7b09a579aeba343317114bf18b4fd92bf Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Wed, 27 Dec 2006 02:17:59 -0500 Subject: Create 'git gc' to perform common maintenance operations. Junio asked for a 'git gc' utility which users can execute on a regular basis to perform basic repository actions such as: * pack-refs --prune * reflog expire * repack -a -d * prune * rerere gc So here is a command which does exactly that. The parameters fed to reflog's expire subcommand can be chosen by the user by setting configuration options in .git/config (or ~/.gitconfig), as users may want different expiration windows for each repository but shouldn't be bothered to remember what they are all of the time. Signed-off-by: Shawn O. Pearce Signed-off-by: Junio C Hamano --- .gitignore | 1 + Documentation/git-gc.txt | 64 ++++++++++++++++++++++++++++++++++++++++++++++++ Documentation/git.txt | 3 +++ Makefile | 2 +- git-gc.sh | 15 ++++++++++++ 5 files changed, 84 insertions(+), 1 deletion(-) create mode 100644 Documentation/git-gc.txt create mode 100755 git-gc.sh diff --git a/.gitignore b/.gitignore index 60e5002bd5..2904f12349 100644 --- a/.gitignore +++ b/.gitignore @@ -42,6 +42,7 @@ git-fmt-merge-msg git-for-each-ref git-format-patch git-fsck-objects +git-gc git-get-tar-commit-id git-grep git-hash-object diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt new file mode 100644 index 0000000000..73d78c15e8 --- /dev/null +++ b/Documentation/git-gc.txt @@ -0,0 +1,64 @@ +git-gc(1) +========= + +NAME +---- +git-gc - Cleanup unnecessary files and optimize the local repository + + +SYNOPSIS +-------- +'git-gc' + +DESCRIPTION +----------- +Runs a number of housekeeping tasks within the current repository, +such as compressing file revisions (to reduce disk space and increase +performance) and removing unreachable objects which may have been +created from prior invocations of gitlink:git-add[1]. + +Users are encouraged to run this task on a regular basis within +each repository to maintain good disk space utilization and good +operating performance. + +Configuration +------------- + +The optional configuration variable 'gc.reflogExpire' can be +set to indicate how long historical entries within each branch's +reflog should remain available in this repository. The setting is +expressed as a length of time, for example '90 days' or '3 months'. +It defaults to '90 days'. + +The optional configuration variable 'gc.reflogExpireUnreachable' +can be set to indicate how long historical reflog entries which +are not part of the current branch should remain available in +this repository. These types of entries are generally created as +a result of using `git commit \--amend` or `git rebase` and are the +commits prior to the amend or rebase occuring. Since these changes +are not part of the current project most users will want to expire +them sooner. This option defaults to '30 days'. + +The optional configuration variable 'gc.rerereresolved' indicates +how long records of conflicted merge you resolved earlier are +kept. This defaults to 60 days. + +The optional configuration variable 'gc.rerereunresolved' indicates +how long records of conflicted merge you have not resolved are +kept. This defaults to 15 days. + + +See Also +-------- +gitlink:git-prune[1] +gitlink:git-reflog[1] +gitlink:git-repack[1] +gitlink:git-rerere[1] + +Author +------ +Written by Shawn O. Pearce + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 4ed3eed13d..36b2126d84 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -212,6 +212,9 @@ gitlink:git-cvsexportcommit[1]:: gitlink:git-cvsserver[1]:: A CVS server emulator for git. +gitlink:git-gc[1]:: + Cleanup unnecessary files and optimize the local repository. + gitlink:git-lost-found[1]:: Recover lost refs that luckily have not yet been pruned. diff --git a/Makefile b/Makefile index 52d4a3a86a..12f4bd22e7 100644 --- a/Makefile +++ b/Makefile @@ -157,7 +157,7 @@ BASIC_LDFLAGS = SCRIPT_SH = \ git-bisect.sh git-checkout.sh \ git-clean.sh git-clone.sh git-commit.sh \ - git-fetch.sh \ + git-fetch.sh git-gc.sh \ git-ls-remote.sh \ git-merge-one-file.sh git-parse-remote.sh \ git-pull.sh git-rebase.sh \ diff --git a/git-gc.sh b/git-gc.sh new file mode 100755 index 0000000000..e55ed19fbd --- /dev/null +++ b/git-gc.sh @@ -0,0 +1,15 @@ +#!/bin/sh +# +# Copyright (c) 2006, Shawn O. Pearce +# +# Cleanup unreachable files and optimize the repository. + +USAGE='' +SUBDIRECTORY_OK=Yes +. git-sh-setup + +git-pack-refs --prune && +git-reflog expire --all && +git-repack -a -d && +git-prune && +git-rerere gc || exit -- cgit v1.2.3 From 8f57b0a0fbfc0a6289bbf126f10ae041f0b508aa Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 27 Dec 2006 02:00:30 -0800 Subject: everyday: replace a few 'prune' and 'repack' with 'gc' Signed-off-by: Junio C Hamano --- Documentation/everyday.txt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/Documentation/everyday.txt b/Documentation/everyday.txt index 5d17ace721..2105a3d2e7 100644 --- a/Documentation/everyday.txt +++ b/Documentation/everyday.txt @@ -34,6 +34,9 @@ Everybody uses these commands to maintain git repositories. * gitlink:git-repack[1] to pack loose objects for efficiency. + * gitlink:git-gc[1] to do common housekeeping tasks such as + repack and prune. + Examples ~~~~~~~~ @@ -41,10 +44,9 @@ Check health and remove cruft.:: + ------------ $ git fsck-objects <1> -$ git prune $ git count-objects <2> $ git repack <3> -$ git prune <4> +$ git gc <4> ------------ + <1> running without `\--full` is usually cheap and assures the @@ -53,7 +55,8 @@ repository health reasonably well. disk space is wasted by not repacking. <3> without `-a` repacks incrementally. repacking every 4-5MB of loose objects accumulation may be a good rule of thumb. -<4> after repack, prune removes the duplicate loose objects. +<4> it is easier to use `git gc` than individual housekeeping commands +such as `prune` and `repack`. This runs `repack -a -d`. Repack a small project into single pack.:: + -- cgit v1.2.3 From a3c11db9ecf5c2a1ec1b25ba809cecb3747750d4 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 27 Dec 2006 14:23:21 -0800 Subject: Use 'repack -a -d -l' instead of 'repack -a -d' in git-gc Otherwise we would end up slurping objects we borrow from alternates. Signed-off-by: Junio C Hamano --- git-gc.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/git-gc.sh b/git-gc.sh index e55ed19fbd..6de55f7292 100755 --- a/git-gc.sh +++ b/git-gc.sh @@ -10,6 +10,6 @@ SUBDIRECTORY_OK=Yes git-pack-refs --prune && git-reflog expire --all && -git-repack -a -d && +git-repack -a -d -l && git-prune && git-rerere gc || exit -- cgit v1.2.3