summaryrefslogtreecommitdiff
path: root/Documentation/git-prune.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-prune.txt')
-rw-r--r--Documentation/git-prune.txt61
1 files changed, 61 insertions, 0 deletions
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
new file mode 100644
index 0000000000..0b44f3015d
--- /dev/null
+++ b/Documentation/git-prune.txt
@@ -0,0 +1,61 @@
+git-prune(1)
+============
+
+NAME
+----
+git-prune - Prunes all unreachable objects from the object database
+
+
+SYNOPSIS
+--------
+'git-prune' [-n] [--] [<head>...]
+
+DESCRIPTION
+-----------
+
+This runs `git-fsck --unreachable` using all the refs
+available in `$GIT_DIR/refs`, optionally with additional set of
+objects specified on the command line, and prunes all
+objects unreachable from any of these head objects from the object database.
+In addition, it
+prunes the unpacked objects that are also found in packs by
+running `git prune-packed`.
+
+OPTIONS
+-------
+
+-n::
+ Do not remove anything; just report what it would
+ remove.
+
+\--::
+ Do not interpret any more arguments as options.
+
+<head>...::
+ In addition to objects
+ reachable from any of our references, keep objects
+ reachable from listed <head>s.
+
+EXAMPLE
+-------
+
+To prune objects not used by your repository nor another that
+borrows from your repository via its
+`.git/objects/info/alternates`:
+
+------------
+$ git prune $(cd ../another && $(git-rev-parse --all))
+------------
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+Documentation
+--------------
+Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the gitlink:git[7] suite
+