Several trivial documentation touch ups.
[git/git.git] / Documentation / git-prune.txt
... / ...
CommitLineData
1git-prune(1)
2============
3
4NAME
5----
6git-prune - Prunes all unreachable objects from the object database
7
8
9SYNOPSIS
10--------
11'git-prune' [-n] [--] [<head>...]
12
13DESCRIPTION
14-----------
15
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
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.
30
31--::
32 Do not interpret any more arguments as options.
33
34<head>...::
35 In addition to objects
36 reachable from any of our references, keep objects
37 reachable from listed <head>s.
38
39EXAMPLE
40-------
41
42To prune objects not used by your repository nor another that
43borrows from your repository via its
44`.git/objects/info/alternates`:
45
46------------
47$ git prune $(cd ../another && $(git-rev-parse --all))
48------------
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---
60Part of the gitlink:git[7] suite
61