Andrew's git / gitweb.git / blobdiff
?
pull --rebase: exit early when the working directory is dirty
[gitweb.git] / Documentation / git-prune.txt
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index fbd344da4028b76bb6f2bbb1401fe836624d0403..3178bc44ca4640e77a799128c9de631168e40c8a 100644 (file)
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -3,24 +3,30 @@ git-prune(1)
 
 NAME
 ----
-git-prune - Prunes all unreachable objects from the object database
+git-prune - Prune all unreachable objects from the object database
 
 
 SYNOPSIS
 --------
-'git-prune' [-n] [--grace=<time>]
+'git-prune' [-n] [--expire <expire>] [--] [<head>...]
 
 DESCRIPTION
 -----------
 
-This runs `git-fsck-objects --unreachable` using all the refs
+NOTE: In most cases, users should run linkgit:git-gc[1], 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`.
 
+Note that unreachable, packed objects will remain.  If this is
+not desired, see linkgit:git-repack[1].
+
 OPTIONS
 -------
 
@@ -28,15 +34,12 @@ OPTIONS
        Do not remove anything; just report what it would
        remove.
 
---grace=<time>::
-       Do not prune loose objects that are younger than the
-       specified time.  This gives a grace period to newly
-       created objects from getting pruned.
-
-////////////////////////////////////////////
 \--::
        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
@@ -52,7 +55,23 @@ borrows from your repository via its
 ------------
 $ 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 linkgit:git-gc[1], 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
 ------
@@ -64,5 +83,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[7] suite