]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-prune.txt
notes: allow --dry-run for -n and --verbose for -v
[thirdparty/git.git] / Documentation / git-prune.txt
CommitLineData
215a7ad1
JH
1git-prune(1)
2============
2cf565c5
DG
3
4NAME
5----
29cf5e12 6git-prune - Prune all unreachable objects from the object database
2cf565c5
DG
7
8
9SYNOPSIS
10--------
0b444cdb 11'git prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
2cf565c5
DG
12
13DESCRIPTION
14-----------
f85a4191 15
0b444cdb
TR
16NOTE: In most cases, users should run 'git gc', which calls
17'git prune'. See the section "NOTES", below.
8d308b35 18
0b444cdb 19This runs 'git fsck --unreachable' using all the refs
cc1b8d8b 20available in `refs/`, optionally with additional set of
58949bb1 21objects specified on the command line, and prunes all unpacked
2b86976b
JH
22objects unreachable from any of these head objects from the object database.
23In addition, it
f85a4191 24prunes the unpacked objects that are also found in packs by
0b444cdb 25running 'git prune-packed'.
f85a4191 26
58949bb1
CF
27Note that unreachable, packed objects will remain. If this is
28not desired, see linkgit:git-repack[1].
29
f85a4191
JH
30OPTIONS
31-------
32
33-n::
34 Do not remove anything; just report what it would
35 remove.
2cf565c5 36
b35ddf41
MG
37-v::
38 Report all removed objects.
39
e994004f 40\--::
c82365dc
JH
41 Do not interpret any more arguments as options.
42
3240240f 43--expire <time>::
f01913e4
JS
44 Only expire loose objects older than <time>.
45
c82365dc 46<head>...::
2b86976b 47 In addition to objects
c82365dc 48 reachable from any of our references, keep objects
2b86976b 49 reachable from listed <head>s.
c82365dc
JH
50
51EXAMPLE
52-------
53
2b86976b 54To prune objects not used by your repository nor another that
c82365dc
JH
55borrows from your repository via its
56`.git/objects/info/alternates`:
57
58------------
b1889c36 59$ git prune $(cd ../another && $(git rev-parse --all))
c82365dc 60------------
2cf565c5 61
8d308b35
JK
62Notes
63-----
64
0b444cdb
TR
65In most cases, users will not need to call 'git prune' directly, but
66should instead call 'git gc', which handles pruning along with
8d308b35
JK
67many other housekeeping tasks.
68
69For a description of which objects are considered for pruning, see
0b444cdb 70'git fsck''s --unreachable option.
8d308b35 71
56ae8df5 72SEE ALSO
8d308b35
JK
73--------
74
75linkgit:git-fsck[1],
76linkgit:git-gc[1],
77linkgit:git-reflog[1]
78
2cf565c5
DG
79Author
80------
81Written by Linus Torvalds <torvalds@osdl.org>
82
83Documentation
84--------------
85Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
86
87GIT
88---
9e1f0a85 89Part of the linkgit:git[1] suite