Documentation: replace: describe new --edit option
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
May 17, 2014 at 14:16 UTC
4e4b125c239a78f3a8fe82e47d1f89fef510980c
1 file changed
+15
-1
Documentation/git-replace.txt
+15
-1
@@ -9,6 +9,7 @@ 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
@@ -63,6 +64,15 @@ OPTIONS
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
@@ -92,7 +102,9 @@ CREATING REPLACEMENT OBJECTS
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
95
-replacement objects from existing objects.
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
@@ -117,6 +129,8 @@ 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