man1/git-prune.1

   1 '\" t
   2 .\"     Title: git-prune
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-05-28
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.1.313.g3a57aa566a
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-PRUNE" "1" "2024\-05\-28" "Git 2\&.45\&.1\&.313\&.g3a57aa" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-prune \- Prune all unreachable objects from the object database
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit prune\fR [\-n] [\-v] [\-\-progress] [\-\-expire <time>] [\-\-] [<head>\&...]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .if n \{\
  40 .sp
  41 .\}
  42 .RS 4
  43 .it 1 an-trap
  44 .nr an-no-space-flag 1
  45 .nr an-break-flag 1
  46 .br
  47 .ps +1
  48 \fBNote\fR
  49 .ps -1
  50 .br
  51 .sp
  52 In most cases, users should run \fIgit gc\fR, which calls \fIgit prune\fR\&. See the section "NOTES", below\&.
  53 .sp .5v
  54 .RE
  55 .sp
  56 This runs \fIgit fsck \-\-unreachable\fR using all the refs available in \fBrefs/\fR, optionally with an additional set of 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 \fIgit prune\-packed\fR\&. It also removes entries from \&.git/shallow that are not reachable by any ref\&.
  57 .sp
  58 Note that unreachable, packed objects will remain\&. If this is not desired, see \fBgit-repack\fR(1)\&.
  59 .SH "OPTIONS"
  60 .PP
  61 \-n, \-\-dry\-run
  62 .RS 4
  63 Do not remove anything; just report what it would remove\&.
  64 .RE
  65 .PP
  66 \-v, \-\-verbose
  67 .RS 4
  68 Report all removed objects\&.
  69 .RE
  70 .PP
  71 \-\-progress
  72 .RS 4
  73 Show progress\&.
  74 .RE
  75 .PP
  76 \-\-expire <time>
  77 .RS 4
  78 Only expire loose objects older than <time>\&.
  79 .RE
  80 .PP
  81 \-\-
  82 .RS 4
  83 Do not interpret any more arguments as options\&.
  84 .RE
  85 .PP
  86 <head>\&...
  87 .RS 4
  88 In addition to objects reachable from any of our references, keep objects reachable from listed <head>s\&.
  89 .RE
  90 .SH "EXAMPLES"
  91 .sp
  92 To prune objects not used by your repository or another that borrows from your repository via its \fB\&.git/objects/info/alternates\fR:
  93 .sp
  94 .if n \{\
  95 .RS 4
  96 .\}
  97 .nf
  98 $ git prune $(cd \&.\&./another && git rev\-parse \-\-all)
  99 .fi
 100 .if n \{\
 101 .RE
 102 .\}
 103 .sp
 104 .SH "NOTES"
 105 .sp
 106 In most cases, users will not need to call \fIgit prune\fR directly, but should instead call \fIgit gc\fR, which handles pruning along with many other housekeeping tasks\&.
 107 .sp
 108 For a description of which objects are considered for pruning, see \fIgit fsck\fR\*(Aqs \-\-unreachable option\&.
 109 .SH "SEE ALSO"
 110 .sp
 111 \fBgit-fsck\fR(1), \fBgit-gc\fR(1), \fBgit-reflog\fR(1)
 112 .SH "GIT"
 113 .sp
 114 Part of the \fBgit\fR(1) suite