Google Git
Sign in
googlers / jrn / git / 96b9e5151bf0cad110d2f0bf16f413b9fc9f606c / . / Documentation / git-prune.txt
blob: 03552dd86fc412b622aff2bcf8feda8e71711b3e [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]
Robert P. J. Day1a1fc2d2017-11-21 10:51:52 -0500[diff] [blame]12'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<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'.
Nguyễn Thái Ngọc Duyeab32962013-12-05 20:02:54 +0700[diff] [blame]27It also removes entries from .git/shallow that are not reachable by
28any ref.
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]29
Chris Frey58949bb2008-05-14 19:22:18 -0400[diff] [blame]30Note that unreachable, packed objects will remain. If this is
31not desired, see linkgit:git-repack[1].
32
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]33OPTIONS
34-------
35
36-n::
René Scharfe24aea032010-08-06 22:28:05 +0200[diff] [blame]37--dry-run::
Junio C Hamanof85a4192005-08-29 17:21:06 -0700[diff] [blame]38 Do not remove anything; just report what it would
39 remove.
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]40
Michael J Gruberb35ddf42008-09-29 18:49:52 +0200[diff] [blame]41-v::
René Scharfe24aea032010-08-06 22:28:05 +0200[diff] [blame]42--verbose::
Michael J Gruberb35ddf42008-09-29 18:49:52 +0200[diff] [blame]43 Report all removed objects.
44
Robert P. J. Day1a1fc2d2017-11-21 10:51:52 -0500[diff] [blame]45--progress::
46 Show progress.
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]47
Stephan Beyer32402402008-06-08 03:36:09 +0200[diff] [blame]48--expire <time>::
Johannes Schindelinf01913e2007-11-29 20:59:55 +0000[diff] [blame]49 Only expire loose objects older than <time>.
50
Robert P. J. Day1a1fc2d2017-11-21 10:51:52 -0500[diff] [blame]51\--::
52 Do not interpret any more arguments as options.
53
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]54<head>...::
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]55 In addition to objects
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]56 reachable from any of our references, keep objects
Junio C Hamano2b869762005-12-08 23:18:41 -0800[diff] [blame]57 reachable from listed <head>s.
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]58
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200[diff] [blame]59EXAMPLES
60--------
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]61
Justin Lebara58088a2014-03-31 15:11:44 -0700[diff] [blame]62To prune objects not used by your repository or another that
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]63borrows from your repository via its
64`.git/objects/info/alternates`:
65
66------------
Jonathon Mah8c3ca722013-07-18 09:53:55 -0700[diff] [blame]67$ git prune $(cd ../another && git rev-parse --all)
Junio C Hamanoc82365d2005-12-08 16:30:24 -0800[diff] [blame]68------------
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]69
Nguyễn Thái Ngọc Duy76a87882018-04-30 17:35:33 +0200[diff] [blame]70NOTES
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]71-----
72
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]73In most cases, users will not need to call 'git prune' directly, but
74should instead call 'git gc', which handles pruning along with
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]75many other housekeeping tasks.
76
77For a description of which objects are considered for pruning, see
Thomas Rast0b444cd2010-01-10 00:33:00 +0100[diff] [blame]78'git fsck''s --unreachable option.
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]79
Junio C Hamano56ae8df2008-05-28 16:55:27 -0700[diff] [blame]80SEE ALSO
Jeff King8d308b32008-04-29 16:45:14 -0400[diff] [blame]81--------
82
83linkgit:git-fsck[1],
84linkgit:git-gc[1],
85linkgit:git-reflog[1]
86
David Greaves2cf565c2005-05-10 22:32:30 +0100[diff] [blame]87GIT
88---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]89Part of the linkgit:git[1] suite