Merge branch 'jc/pathcheck'
[gitweb.git] / Documentation / git-prune.txt
index 3367c9b21452db7e73ec29f03d36fd2d11b56b97..f694fcbde809b17dc9fd974eba458dd7805dc426 100644 (file)
@@ -8,15 +8,16 @@ git-prune - Prunes all unreachable objects from the object database
 
 SYNOPSIS
 --------
-'git-prune' [-n]
+'git-prune' [-n] [--] [<head>...]
 
 DESCRIPTION
 -----------
 
-This runs `git-fsck-objects --unreachable` using the heads
-specified on the command line (or `$GIT_DIR/refs/heads/\*` and
-`$GIT_DIR/refs/tags/\*` if none is specified), and prunes all
-unreachable objects from the object database.  In addition, it
+This runs `git-fsck-objects --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`.
 
@@ -27,6 +28,24 @@ OPTIONS
        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
 ------