diff options
Diffstat (limited to 'Documentation/git-prune.txt')
| -rw-r--r-- | Documentation/git-prune.txt | 57 |
1 files changed, 41 insertions, 16 deletions
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index 0b44f3015d..7a493c80f7 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -3,34 +3,51 @@ git-prune(1) NAME ---- -git-prune - Prunes all unreachable objects from the object database +git-prune - Prune all unreachable objects from the object database SYNOPSIS -------- -'git-prune' [-n] [--] [<head>...] +[verse] +'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...] DESCRIPTION ----------- -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 +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 `refs/`, optionally with additional set of +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'. +It also removes entries from .git/shallow that are not reachable by +any ref. + +Note that unreachable, packed objects will remain. If this is +not desired, see linkgit:git-repack[1]. OPTIONS ------- -n:: +--dry-run:: Do not remove anything; just report what it would remove. +-v:: +--verbose:: + Report all removed objects. + \--:: Do not interpret any more arguments as options. +--expire <time>:: + Only expire loose objects older than <time>. + <head>...:: In addition to objects reachable from any of our references, keep objects @@ -39,23 +56,31 @@ OPTIONS EXAMPLE ------- -To prune objects not used by your repository nor another that +To prune objects not used by your repository or another that 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) ------------ -Author ------- -Written by Linus Torvalds <torvalds@osdl.org> +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. -Documentation --------------- -Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. +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] GIT --- -Part of the gitlink:git[7] suite - +Part of the linkgit:git[1] suite |