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