Merge branch 'cb/byte-order'
[git/git.git] / Documentation / git-replace.txt
1 git-replace(1)
2 ==============
3
4 NAME
5 ----
6 git-replace - Create, list, delete refs to replace objects
7
8 SYNOPSIS
9 --------
10 [verse]
11 'git replace' [-f] <object> <replacement>
12 'git replace' [-f] --edit <object>
13 'git replace' -d <object>...
14 'git replace' [--format=<format>] [-l [<pattern>]]
15
16 DESCRIPTION
17 -----------
18 Adds a 'replace' reference in `refs/replace/` namespace.
19
20 The name of the 'replace' reference is the SHA-1 of the object that is
21 replaced. The content of the 'replace' reference is the SHA-1 of the
22 replacement object.
23
24 The replaced object and the replacement object must be of the same type.
25 This restriction can be bypassed using `-f`.
26
27 Unless `-f` is given, the 'replace' reference must not yet exist.
28
29 There is no other restriction on the replaced and replacement objects.
30 Merge commits can be replaced by non-merge commits and vice versa.
31
32 Replacement references will be used by default by all Git commands
33 except those doing reachability traversal (prune, pack transfer and
34 fsck).
35
36 It is possible to disable use of replacement references for any
37 command using the `--no-replace-objects` option just after 'git'.
38
39 For example if commit 'foo' has been replaced by commit 'bar':
40
41 ------------------------------------------------
42 $ git --no-replace-objects cat-file commit foo
43 ------------------------------------------------
44
45 shows information about commit 'foo', while:
46
47 ------------------------------------------------
48 $ git cat-file commit foo
49 ------------------------------------------------
50
51 shows information about commit 'bar'.
52
53 The 'GIT_NO_REPLACE_OBJECTS' environment variable can be set to
54 achieve the same effect as the `--no-replace-objects` option.
55
56 OPTIONS
57 -------
58 -f::
59 --force::
60 If an existing replace ref for the same object exists, it will
61 be overwritten (instead of failing).
62
63 -d::
64 --delete::
65 Delete existing replace refs for the given objects.
66
67 --edit <object>::
68 Edit an object's content interactively. The existing content
69 for <object> is pretty-printed into a temporary file, an
70 editor is launched on the file, and the result is parsed to
71 create a new object of the same type as <object>. A
72 replacement ref is then created to replace <object> with the
73 newly created object. See linkgit:git-var[1] for details about
74 how the editor will be chosen.
75
76 -l <pattern>::
77 --list <pattern>::
78 List replace refs for objects that match the given pattern (or
79 all if no pattern is given).
80 Typing "git replace" without arguments, also lists all replace
81 refs.
82
83 --format=<format>::
84 When listing, use the specified <format>, which can be one of
85 'short', 'medium' and 'long'. When omitted, the format
86 defaults to 'short'.
87
88 FORMATS
89 -------
90
91 The following format are available:
92
93 * 'short':
94 <replaced sha1>
95 * 'medium':
96 <replaced sha1> -> <replacement sha1>
97 * 'long':
98 <replaced sha1> (<replaced type>) -> <replacement sha1> (<replacement type>)
99
100 CREATING REPLACEMENT OBJECTS
101 ----------------------------
102
103 linkgit:git-filter-branch[1], linkgit:git-hash-object[1] and
104 linkgit:git-rebase[1], among other git commands, can be used to create
105 replacement objects from existing objects. The `--edit` option can
106 also be used with 'git replace' to create a replacement object by
107 editing an existing object.
108
109 If you want to replace many blobs, trees or commits that are part of a
110 string of commits, you may just want to create a replacement string of
111 commits and then only replace the commit at the tip of the target
112 string of commits with the commit at the tip of the replacement string
113 of commits.
114
115 BUGS
116 ----
117 Comparing blobs or trees that have been replaced with those that
118 replace them will not work properly. And using `git reset --hard` to
119 go back to a replaced commit will move the branch to the replacement
120 commit instead of the replaced commit.
121
122 There may be other problems when using 'git rev-list' related to
123 pending objects.
124
125 SEE ALSO
126 --------
127 linkgit:git-hash-object[1]
128 linkgit:git-filter-branch[1]
129 linkgit:git-rebase[1]
130 linkgit:git-tag[1]
131 linkgit:git-branch[1]
132 linkgit:git-commit[1]
133 linkgit:git-var[1]
134 linkgit:git[1]
135
136 GIT
137 ---
138 Part of the linkgit:git[1] suite