Documentation/git-prune.txt

   1 git-prune(1)
   2 ============
   3
   4 NAME
   5 ----
   6 git-prune - Prune all unreachable objects from the object database
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-prune' [-n] [--expire <expire>] [--] [<head>...]
  12
  13 DESCRIPTION
  14 -----------
  15
  16 NOTE: In most cases, users should run linkgit:git-gc[1], which calls
  17 git-prune. See the section "NOTES", below.
  18
  19 This runs `git-fsck --unreachable` using all the refs
  20 available in `$GIT_DIR/refs`, optionally with additional set of
  21 objects specified on the command line, and prunes all
  22 objects unreachable from any of these head objects from the object database.
  23 In addition, it
  24 prunes the unpacked objects that are also found in packs by
  25 running `git prune-packed`.
  26
  27 OPTIONS
  28 -------
  29
  30 -n::
  31         Do not remove anything; just report what it would
  32         remove.
  33
  34 \--::
  35         Do not interpret any more arguments as options.
  36
  37 \--expire <time>::
  38         Only expire loose objects older than <time>.
  39
  40 <head>...::
  41         In addition to objects
  42         reachable from any of our references, keep objects
  43         reachable from listed <head>s.
  44
  45 EXAMPLE
  46 -------
  47
  48 To prune objects not used by your repository nor another that
  49 borrows from your repository via its
  50 `.git/objects/info/alternates`:
  51
  52 ------------
  53 $ git prune $(cd ../another && $(git-rev-parse --all))
  54 ------------
  55
  56 Notes
  57 -----
  58
  59 In most cases, users will not need to call git-prune directly, but
  60 should instead call linkgit:git-gc[1], which handles pruning along with
  61 many other housekeeping tasks.
  62
  63 For a description of which objects are considered for pruning, see
  64 git-fsck's --unreachable option.
  65
  66 See Also
  67 --------
  68
  69 linkgit:git-fsck[1],
  70 linkgit:git-gc[1],
  71 linkgit:git-reflog[1]
  72
  73 Author
  74 ------
  75 Written by Linus Torvalds <torvalds@osdl.org>
  76
  77 Documentation
  78 --------------
  79 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  80
  81 GIT
  82 ---
  83 Part of the linkgit:git[7] suite