man1/git-replace.1

   1 '\" t
   2 .\"     Title: git-replace
   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: 2023-10-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.424.gceadf0f3cf
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-REPLACE" "1" "2023\-10\-20" "Git 2\&.42\&.0\&.424\&.gceadf0" "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-replace \- Create, list, delete refs to replace objects
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit replace\fR [\-f] <object> <replacement>
  36 \fIgit replace\fR [\-f] \-\-edit <object>
  37 \fIgit replace\fR [\-f] \-\-graft <commit> [<parent>\&...]
  38 \fIgit replace\fR [\-f] \-\-convert\-graft\-file
  39 \fIgit replace\fR \-d <object>\&...
  40 \fIgit replace\fR [\-\-format=<format>] [\-l [<pattern>]]
  41 .fi
  42 .sp
  43 .SH "DESCRIPTION"
  44 .sp
  45 Adds a \fIreplace\fR reference in \fBrefs/replace/\fR namespace\&.
  46 .sp
  47 The name of the \fIreplace\fR reference is the SHA\-1 of the object that is replaced\&. The content of the \fIreplace\fR reference is the SHA\-1 of the replacement object\&.
  48 .sp
  49 The replaced object and the replacement object must be of the same type\&. This restriction can be bypassed using \fB\-f\fR\&.
  50 .sp
  51 Unless \fB\-f\fR is given, the \fIreplace\fR reference must not yet exist\&.
  52 .sp
  53 There is no other restriction on the replaced and replacement objects\&. Merge commits can be replaced by non\-merge commits and vice versa\&.
  54 .sp
  55 Replacement references will be used by default by all Git commands except those doing reachability traversal (prune, pack transfer and fsck)\&.
  56 .sp
  57 It is possible to disable use of replacement references for any command using the \fB\-\-no\-replace\-objects\fR option just after \fIgit\fR\&.
  58 .sp
  59 For example if commit \fIfoo\fR has been replaced by commit \fIbar\fR:
  60 .sp
  61 .if n \{\
  62 .RS 4
  63 .\}
  64 .nf
  65 $ git \-\-no\-replace\-objects cat\-file commit foo
  66 .fi
  67 .if n \{\
  68 .RE
  69 .\}
  70 .sp
  71 .sp
  72 shows information about commit \fIfoo\fR, while:
  73 .sp
  74 .if n \{\
  75 .RS 4
  76 .\}
  77 .nf
  78 $ git cat\-file commit foo
  79 .fi
  80 .if n \{\
  81 .RE
  82 .\}
  83 .sp
  84 .sp
  85 shows information about commit \fIbar\fR\&.
  86 .sp
  87 The \fBGIT_NO_REPLACE_OBJECTS\fR environment variable can be set to achieve the same effect as the \fB\-\-no\-replace\-objects\fR option\&.
  88 .SH "OPTIONS"
  89 .PP
  90 \-f, \-\-force
  91 .RS 4
  92 If an existing replace ref for the same object exists, it will be overwritten (instead of failing)\&.
  93 .RE
  94 .PP
  95 \-d, \-\-delete
  96 .RS 4
  97 Delete existing replace refs for the given objects\&.
  98 .RE
  99 .PP
 100 \-\-edit <object>
 101 .RS 4
 102 Edit an object\(cqs content interactively\&. The existing content for <object> is pretty\-printed into a temporary file, an editor is launched on the file, and the result is parsed to create a new object of the same type as <object>\&. A replacement ref is then created to replace <object> with the newly created object\&. See
 103 \fBgit-var\fR(1)
 104 for details about how the editor will be chosen\&.
 105 .RE
 106 .PP
 107 \-\-raw
 108 .RS 4
 109 When editing, provide the raw object contents rather than pretty\-printed ones\&. Currently this only affects trees, which will be shown in their binary form\&. This is harder to work with, but can help when repairing a tree that is so corrupted it cannot be pretty\-printed\&. Note that you may need to configure your editor to cleanly read and write binary data\&.
 110 .RE
 111 .PP
 112 \-\-graft <commit> [<parent>\&...]
 113 .RS 4
 114 Create a graft commit\&. A new commit is created with the same content as <commit> except that its parents will be [<parent>\&...] instead of <commit>\*(Aqs parents\&. A replacement ref is then created to replace <commit> with the newly created commit\&. Use
 115 \fB\-\-convert\-graft\-file\fR
 116 to convert a
 117 \fB$GIT_DIR/info/grafts\fR
 118 file and use replace refs instead\&.
 119 .RE
 120 .PP
 121 \-\-convert\-graft\-file
 122 .RS 4
 123 Creates graft commits for all entries in
 124 \fB$GIT_DIR/info/grafts\fR
 125 and deletes that file upon success\&. The purpose is to help users with transitioning off of the now\-deprecated graft file\&.
 126 .RE
 127 .PP
 128 \-l <pattern>, \-\-list <pattern>
 129 .RS 4
 130 List replace refs for objects that match the given pattern (or all if no pattern is given)\&. Typing "git replace" without arguments, also lists all replace refs\&.
 131 .RE
 132 .PP
 133 \-\-format=<format>
 134 .RS 4
 135 When listing, use the specified <format>, which can be one of
 136 \fIshort\fR,
 137 \fImedium\fR
 138 and
 139 \fIlong\fR\&. When omitted, the format defaults to
 140 \fIshort\fR\&.
 141 .RE
 142 .SH "FORMATS"
 143 .sp
 144 The following format are available:
 145 .sp
 146 .RS 4
 147 .ie n \{\
 148 \h'-04'\(bu\h'+03'\c
 149 .\}
 150 .el \{\
 151 .sp -1
 152 .IP \(bu 2.3
 153 .\}
 154 \fIshort\fR: <replaced sha1>
 155 .RE
 156 .sp
 157 .RS 4
 158 .ie n \{\
 159 \h'-04'\(bu\h'+03'\c
 160 .\}
 161 .el \{\
 162 .sp -1
 163 .IP \(bu 2.3
 164 .\}
 165 \fImedium\fR: <replaced sha1> \(-> <replacement sha1>
 166 .RE
 167 .sp
 168 .RS 4
 169 .ie n \{\
 170 \h'-04'\(bu\h'+03'\c
 171 .\}
 172 .el \{\
 173 .sp -1
 174 .IP \(bu 2.3
 175 .\}
 176 \fIlong\fR: <replaced sha1> (<replaced type>) \(-> <replacement sha1> (<replacement type>)
 177 .RE
 178 .SH "CREATING REPLACEMENT OBJECTS"
 179 .sp
 180 \fBgit-hash-object\fR(1), \fBgit-rebase\fR(1), and \m[blue]\fBgit\-filter\-repo\fR\m[]\&\s-2\u[1]\d\s+2, among other git commands, can be used to create replacement objects from existing objects\&. The \fB\-\-edit\fR option can also be used with \fIgit replace\fR to create a replacement object by editing an existing object\&.
 181 .sp
 182 If you want to replace many blobs, trees or commits that are part of a string of commits, you may just want to create a replacement string of commits and then only replace the commit at the tip of the target string of commits with the commit at the tip of the replacement string of commits\&.
 183 .SH "BUGS"
 184 .sp
 185 Comparing blobs or trees that have been replaced with those that replace them will not work properly\&. And using \fBgit reset \-\-hard\fR to go back to a replaced commit will move the branch to the replacement commit instead of the replaced commit\&.
 186 .sp
 187 There may be other problems when using \fIgit rev\-list\fR related to pending objects\&.
 188 .SH "SEE ALSO"
 189 .sp
 190 \fBgit-hash-object\fR(1) \fBgit-rebase\fR(1) \fBgit-tag\fR(1) \fBgit-branch\fR(1) \fBgit-commit\fR(1) \fBgit-var\fR(1) \fBgit\fR(1) \m[blue]\fBgit\-filter\-repo\fR\m[]\&\s-2\u[1]\d\s+2
 191 .SH "GIT"
 192 .sp
 193 Part of the \fBgit\fR(1) suite
 194 .SH "NOTES"
 195 .IP " 1." 4
 196 git-filter-repo
 197 .RS 4
 198 \%https://github.com/newren/git-filter-repo
 199 .RE