Code

Merge branch 'sp/maint-bash-completion-optim'
[git.git] / Documentation / git-prune.txt
index f92bb8cfa069283b0e8b78b717eedbef81bbe647..54f1dab38de9e01d8452753ac6028875b91d5f6b 100644 (file)
@@ -13,16 +13,19 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-NOTE: In most cases, users should run linkgit:git-gc[1], which calls
-git-prune. See the section "NOTES", below.
+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
+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
 -------
@@ -34,7 +37,7 @@ OPTIONS
 \--::
        Do not interpret any more arguments as options.
 
-\--expire <time>::
+--expire <time>::
        Only expire loose objects older than <time>.
 
 <head>...::
@@ -50,20 +53,20 @@ 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 linkgit:git-gc[1], which handles pruning along with
+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.
+'git-fsck''s --unreachable option.
 
-See Also
+SEE ALSO
 --------
 
 linkgit:git-fsck[1],
@@ -80,4 +83,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite