diff: add option to show context between close hunks
[gitweb.git] / Documentation / git-prune.txt
index 0ace233d18383f53ca4d31baaa8e3c230ddb874b..da6055d4b8cf78aff16fa553e684b0b3ed57138e 100644 (file)
@@ -8,18 +8,24 @@ git-prune - Prune all unreachable objects from the object database
 
 SYNOPSIS
 --------
-'git-prune' [-n] [--] [<head>...]
+'git-prune' [-n] [-v] [--expire <expire>] [--] [<head>...]
 
 DESCRIPTION
 -----------
 
-This runs `git-fsck --unreachable` using all the refs
+NOTE: In most cases, users should run 'git-gc', which calls
+'git-prune'. See the section "NOTES", below.
+
+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 specified on the command line, and prunes all unpacked
 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`.
+running 'git-prune-packed'.
+
+Note that unreachable, packed objects will remain.  If this is
+not desired, see linkgit:git-repack[1].
 
 OPTIONS
 -------
@@ -28,9 +34,15 @@ OPTIONS
        Do not remove anything; just report what it would
        remove.
 
+-v::
+       Report all removed objects.
+
 \--::
        Do not interpret any more arguments as options.
 
+--expire <time>::
+       Only expire loose objects older than <time>.
+
 <head>...::
        In addition to objects
        reachable from any of our references, keep objects
@@ -44,9 +56,26 @@ borrows from your repository via its
 `.git/objects/info/alternates`:
 
 ------------
-$ git prune $(cd ../another && $(git-rev-parse --all))
+$ git prune $(cd ../another && $(git rev-parse --all))
 ------------
 
+Notes
+-----
+
+In most cases, users will not need to call 'git-prune' directly, but
+should instead call 'git-gc', which handles pruning along with
+many other housekeeping tasks.
+
+For a description of which objects are considered for pruning, see
+'git-fsck''s --unreachable option.
+
+SEE ALSO
+--------
+
+linkgit:git-fsck[1],
+linkgit:git-gc[1],
+linkgit:git-reflog[1]
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
@@ -57,4 +86,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite