diff options
Diffstat (limited to 'Documentation/git-prune.txt')
| -rw-r--r-- | Documentation/git-prune.txt | 35 |
1 files changed, 29 insertions, 6 deletions
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index f151cff5d9..54f1dab38d 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -13,13 +13,19 @@ SYNOPSIS DESCRIPTION ----------- -This runs `git-fsck --unreachable` using all the refs +NOTE: In most cases, users should run 'git-gc', which calls +'git-prune'. See the section "NOTES", below. + +This runs 'git-fsck --unreachable' using all the refs available in `$GIT_DIR/refs`, optionally with additional set of -objects specified on the command line, and prunes all +objects specified on the command line, and prunes all unpacked objects unreachable from any of these head objects from the object database. In addition, it prunes the unpacked objects that are also found in packs by -running `git prune-packed`. +running 'git-prune-packed'. + +Note that unreachable, packed objects will remain. If this is +not desired, see linkgit:git-repack[1]. OPTIONS ------- @@ -31,7 +37,7 @@ OPTIONS \--:: Do not interpret any more arguments as options. -\--expire <time>:: +--expire <time>:: Only expire loose objects older than <time>. <head>...:: @@ -47,9 +53,26 @@ borrows from your repository via its `.git/objects/info/alternates`: ------------ -$ git prune $(cd ../another && $(git-rev-parse --all)) +$ git prune $(cd ../another && $(git rev-parse --all)) ------------ +Notes +----- + +In most cases, users will not need to call 'git-prune' directly, but +should instead call 'git-gc', which handles pruning along with +many other housekeeping tasks. + +For a description of which objects are considered for pruning, see +'git-fsck''s --unreachable option. + +SEE ALSO +-------- + +linkgit:git-fsck[1], +linkgit:git-gc[1], +linkgit:git-reflog[1] + Author ------ Written by Linus Torvalds <torvalds@osdl.org> @@ -60,4 +83,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite |