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 `git-gc`, 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 unpacked
  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 Note that unreachable, packed objects will remain.  If this is
  28 not desired, see linkgit:git-repack[1].
  29
  30 OPTIONS
  31 -------
  32
  33 -n::
  34         Do not remove anything; just report what it would
  35         remove.
  36
  37 \--::
  38         Do not interpret any more arguments as options.
  39
  40 --expire <time>::
  41         Only expire loose objects older than <time>.
  42
  43 <head>...::
  44         In addition to objects
  45         reachable from any of our references, keep objects
  46         reachable from listed <head>s.
  47
  48 EXAMPLE
  49 -------
  50
  51 To prune objects not used by your repository nor another that
  52 borrows from your repository via its
  53 `.git/objects/info/alternates`:
  54
  55 ------------
  56 $ git prune $(cd ../another && $(git rev-parse --all))
  57 ------------
  58
  59 Notes
  60 -----
  61
  62 In most cases, users will not need to call `git-prune` directly, but
  63 should instead call `git-gc`, which handles pruning along with
  64 many other housekeeping tasks.
  65
  66 For a description of which objects are considered for pruning, see
  67 `git-fsck`'s --unreachable option.
  68
  69 SEE ALSO
  70 --------
  71
  72 linkgit:git-fsck[1],
  73 linkgit:git-gc[1],
  74 linkgit:git-reflog[1]
  75
  76 Author
  77 ------
  78 Written by Linus Torvalds <torvalds@osdl.org>
  79
  80 Documentation
  81 --------------
  82 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  83
  84 GIT
  85 ---
  86 Part of the linkgit:git[1] suite