Several trivial documentation touch ups.
[git/git.git] / Documentation / git-prune.txt
CommitLineData
215a7ad1
JH
1git-prune(1)
2============
2cf565c5
DG
3
4NAME
5----
215a7ad1 6git-prune - Prunes all unreachable objects from the object database
2cf565c5
DG
7
8
9SYNOPSIS
10--------
c82365dc 11'git-prune' [-n] [--] [<head>...]
2cf565c5
DG
12
13DESCRIPTION
14-----------
f85a4191 15
2b86976b
JH
16This runs `git-fsck-objects --unreachable` using all the refs
17available in `$GIT_DIR/refs`, optionally with additional set of
18objects specified on the command line, and prunes all
19objects unreachable from any of these head objects from the object database.
20In addition, it
f85a4191
JH
21prunes the unpacked objects that are also found in packs by
22running `git prune-packed`.
23
24OPTIONS
25-------
26
27-n::
28 Do not remove anything; just report what it would
29 remove.
2cf565c5 30
c82365dc
JH
31--::
32 Do not interpret any more arguments as options.
33
34<head>...::
2b86976b 35 In addition to objects
c82365dc 36 reachable from any of our references, keep objects
2b86976b 37 reachable from listed <head>s.
c82365dc
JH
38
39EXAMPLE
40-------
41
2b86976b 42To prune objects not used by your repository nor another that
c82365dc
JH
43borrows from your repository via its
44`.git/objects/info/alternates`:
45
46------------
2b86976b 47$ git prune $(cd ../another && $(git-rev-parse --all))
c82365dc 48------------
2cf565c5
DG
49
50Author
51------
52Written by Linus Torvalds <torvalds@osdl.org>
53
54Documentation
55--------------
56Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
57
58GIT
59---
a7154e91 60Part of the gitlink:git[7] suite
2cf565c5 61