Google Git
Sign in
googlers / jrn / git / 09b7e2204a8e41307192c800162e438ec09ddd2c / . / Documentation / git-prune.txt
blob: 80d01b05710e250a5f1d548fca3fba54d50e0f29 [file] [log] [blame]
Junio C Hamano215a7ad2005-09-07 17:26:23 -0700[diff] [blame]1git-prune(1)
2============
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]3
4NAME
5----
william pursell29cf5e12007-06-09 16:44:12 +0100[diff] [blame]6git-prune - Prune all unreachable objects from the object database
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]7
8
9SYNOPSIS
10--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -0400[diff] [blame]11[verse]
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]12'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]13
14DESCRIPTION
15-----------
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]16
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]17NOTE: In most cases, users should run 'git gc', which calls
18'git prune'. See the section "NOTES", below.
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]19
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]20This runs 'git fsck --unreachable' using all the refs
Jeff Kingcc1b8d82010-02-17 20:16:20 -0500[diff] [blame]21available in `refs/`, optionally with additional set of
Chris Frey58949bb2008-05-14 19:22:18 -0400[diff] [blame]22objects specified on the command line, and prunes all unpacked
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]23objects unreachable from any of these head objects from the object database.
24In addition, it
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]25prunes the unpacked objects that are also found in packs by
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]26running 'git prune-packed'.
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]27
Chris Frey58949bb2008-05-14 19:22:18 -0400[diff] [blame]28Note that unreachable, packed objects will remain. If this is
29not desired, see linkgit:git-repack[1].
30
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]31OPTIONS
32-------
33
34-n::
René Scharfe24aea032010-08-06 22:28:05 +0200[diff] [blame]35--dry-run::
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]36 Do not remove anything; just report what it would
37 remove.
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]38
Michael J Gruberb35ddf42008-09-29 18:49:52 +0200[diff] [blame]39-v::
René Scharfe24aea032010-08-06 22:28:05 +0200[diff] [blame]40--verbose::
Michael J Gruberb35ddf42008-09-29 18:49:52 +0200[diff] [blame]41 Report all removed objects.
42
seane9940042006-05-05 15:05:24 -0400[diff] [blame]43\--::
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]44 Do not interpret any more arguments as options.
45
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]46--expire <time>::
Johannes Schindelinf01913e2007-11-29 20:59:55 +0000[diff] [blame]47 Only expire loose objects older than <time>.
48
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]49<head>...::
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]50 In addition to objects
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]51 reachable from any of our references, keep objects
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]52 reachable from listed <head>s.
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]53
54EXAMPLE
55-------
56
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]57To prune objects not used by your repository nor another that
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]58borrows from your repository via its
59`.git/objects/info/alternates`:
60
61------------
Jonathan Niederb1889c32008-06-30 01:09:04 -0500[diff] [blame]62$ git prune $(cd ../another && $(git rev-parse --all))
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]63------------
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]64
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]65Notes
66-----
67
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]68In most cases, users will not need to call 'git prune' directly, but
69should instead call 'git gc', which handles pruning along with
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]70many other housekeeping tasks.
71
72For a description of which objects are considered for pruning, see
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]73'git fsck''s --unreachable option.
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]74
Junio C Hamano56ae8df2008-05-28 16:55:27 -0700[diff] [blame]75SEE ALSO
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]76--------
77
78linkgit:git-fsck[1],
79linkgit:git-gc[1],
80linkgit:git-reflog[1]
81
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]82GIT
83---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]84Part of the linkgit:git[1] suite