From 5229946f8d292efc1da16c42f245e2acbfcb3bfb Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 28 Dec 2006 00:59:38 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.0-rc0-g7c20b --- everyday.html | 14 ++- everyday.txt | 9 +- git-gc.html | 330 ++++++++++++++++++++++++++++++++++++++++++++++++++ git-gc.txt | 64 ++++++++++ git.html | 10 +- git.txt | 3 + 6 files changed, 422 insertions(+), 8 deletions(-) create mode 100644 git-gc.html create mode 100644 git-gc.txt diff --git a/everyday.html b/everyday.html index c2562a7c6..c36c9357f 100644 --- a/everyday.html +++ b/everyday.html @@ -303,6 +303,12 @@ of git repositories.

git-repack(1) to pack loose objects for efficiency.

+
  • +

    +git-gc(1) to do common housekeeping tasks such as + repack and prune. +

    +

    • Examples

    @@ -313,10 +319,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. @@ -339,7 +344,8 @@ of loose objects accumulation may be a good rule of thumb.

    2. -after repack, prune removes the duplicate loose objects. +it is easier to use git gc than individual housekeeping commands +such as prune and repack. This runs repack -a -d.

    @@ -1064,7 +1070,7 @@ upload to public HTTP server hosted by your ISP. diff --git a/everyday.txt b/everyday.txt index 5d17ace72..2105a3d2e 100644 --- a/everyday.txt +++ b/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.:: + diff --git a/git-gc.html b/git-gc.html new file mode 100644 index 000000000..d98934e7b --- /dev/null +++ b/git-gc.html @@ -0,0 +1,330 @@ + + + + + + +git-gc(1) + + + +

    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 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

    +
    +

    git-prune(1) +git-reflog(1) +git-repack(1) +git-rerere(1)

    +
    +

    Author

    +
    +

    Written by Shawn O. Pearce <spearce@spearce.org>

    +
    +

    GIT

    +
    +

    Part of the git(7) suite

    +
    + + + diff --git a/git-gc.txt b/git-gc.txt new file mode 100644 index 000000000..73d78c15e --- /dev/null +++ b/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/git.html b/git.html index 55fa6503c..ecdbbca67 100644 --- a/git.html +++ b/git.html @@ -710,6 +710,14 @@ ancillary user utilities.

    +git-gc(1) +
    +
    +

    + Cleanup unnecessary files and optimize the local repository. +

    +
    +
    git-lost-found(1)
    @@ -2277,7 +2285,7 @@ contributors on the git-list <git@vger.kernel.org>.

    diff --git a/git.txt b/git.txt index 4ed3eed13..36b2126d8 100644 --- a/git.txt +++ b/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. -- 2.26.2