]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-rebase(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-rebase - Forward-port local commits to the updated upstream head |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
e448ff87 | 10 | [verse] |
1b1dce4b | 11 | 'git-rebase' [-i | --interactive] [-v | --verbose] [--merge] [-C<n>] |
f09c9b8c | 12 | [-p | --preserve-merges] [--onto <newbase>] <upstream> [<branch>] |
cc120056 | 13 | 'git-rebase' --continue | --skip | --abort |
031321c6 | 14 | |
7fc9d69f JH |
15 | DESCRIPTION |
16 | ----------- | |
5ca2db53 SP |
17 | If <branch> is specified, git-rebase will perform an automatic |
18 | `git checkout <branch>` before doing anything else. Otherwise | |
19 | it remains on the current branch. | |
20 | ||
21 | All changes made by commits in the current branch but that are not | |
22 | in <upstream> are saved to a temporary area. This is the same set | |
23 | of commits that would be shown by `git log <upstream>..HEAD`. | |
24 | ||
25 | The current branch is reset to <upstream>, or <newbase> if the | |
26 | --onto option was supplied. This has the exact same effect as | |
27 | `git reset --hard <upstream>` (or <newbase>). | |
28 | ||
29 | The commits that were previously saved into the temporary area are | |
30 | then reapplied to the current branch, one by one, in order. | |
69a60af5 | 31 | |
031321c6 SE |
32 | It is possible that a merge failure will prevent this process from being |
33 | completely automatic. You will have to resolve any such merge failure | |
cc120056 SE |
34 | and run `git rebase --continue`. Another option is to bypass the commit |
35 | that caused the merge failure with `git rebase --skip`. To restore the | |
36 | original <branch> and remove the .dotest working files, use the command | |
37 | `git rebase --abort` instead. | |
031321c6 | 38 | |
69a60af5 CW |
39 | Assume the following history exists and the current branch is "topic": |
40 | ||
031321c6 | 41 | ------------ |
69a60af5 CW |
42 | A---B---C topic |
43 | / | |
44 | D---E---F---G master | |
031321c6 | 45 | ------------ |
69a60af5 | 46 | |
228382ae | 47 | From this point, the result of either of the following commands: |
69a60af5 | 48 | |
031321c6 | 49 | |
69a60af5 CW |
50 | git-rebase master |
51 | git-rebase master topic | |
52 | ||
53 | would be: | |
54 | ||
031321c6 | 55 | ------------ |
69a60af5 CW |
56 | A'--B'--C' topic |
57 | / | |
58 | D---E---F---G master | |
031321c6 | 59 | ------------ |
69a60af5 | 60 | |
e52775f4 JN |
61 | The latter form is just a short-hand of `git checkout topic` |
62 | followed by `git rebase master`. | |
69a60af5 | 63 | |
e52775f4 JN |
64 | Here is how you would transplant a topic branch based on one |
65 | branch to another, to pretend that you forked the topic branch | |
66 | from the latter branch, using `rebase --onto`. | |
69a60af5 | 67 | |
e52775f4 JN |
68 | First let's assume your 'topic' is based on branch 'next'. |
69 | For example feature developed in 'topic' depends on some | |
70 | functionality which is found in 'next'. | |
69a60af5 | 71 | |
031321c6 | 72 | ------------ |
e52775f4 JN |
73 | o---o---o---o---o master |
74 | \ | |
75 | o---o---o---o---o next | |
76 | \ | |
77 | o---o---o topic | |
78 | ------------ | |
79 | ||
80 | We would want to make 'topic' forked from branch 'master', | |
81 | for example because the functionality 'topic' branch depend on | |
82 | got merged into more stable 'master' branch, like this: | |
83 | ||
84 | ------------ | |
85 | o---o---o---o---o master | |
86 | | \ | |
87 | | o'--o'--o' topic | |
88 | \ | |
89 | o---o---o---o---o next | |
031321c6 | 90 | ------------ |
7fc9d69f | 91 | |
e52775f4 JN |
92 | We can get this using the following command: |
93 | ||
94 | git-rebase --onto master next topic | |
95 | ||
96 | ||
97 | Another example of --onto option is to rebase part of a | |
98 | branch. If we have the following situation: | |
99 | ||
100 | ------------ | |
101 | H---I---J topicB | |
102 | / | |
103 | E---F---G topicA | |
104 | / | |
105 | A---B---C---D master | |
106 | ------------ | |
107 | ||
108 | then the command | |
109 | ||
110 | git-rebase --onto master topicA topicB | |
111 | ||
112 | would result in: | |
113 | ||
114 | ------------ | |
115 | H'--I'--J' topicB | |
116 | / | |
117 | | E---F---G topicA | |
118 | |/ | |
119 | A---B---C---D master | |
120 | ------------ | |
121 | ||
122 | This is useful when topicB does not depend on topicA. | |
123 | ||
ea81fcc5 SP |
124 | A range of commits could also be removed with rebase. If we have |
125 | the following situation: | |
126 | ||
127 | ------------ | |
128 | E---F---G---H---I---J topicA | |
129 | ------------ | |
130 | ||
131 | then the command | |
132 | ||
13cc4c81 | 133 | git-rebase --onto topicA~5 topicA~3 topicA |
ea81fcc5 SP |
134 | |
135 | would result in the removal of commits F and G: | |
136 | ||
137 | ------------ | |
138 | E---H'---I'---J' topicA | |
139 | ------------ | |
140 | ||
141 | This is useful if F and G were flawed in some way, or should not be | |
142 | part of topicA. Note that the argument to --onto and the <upstream> | |
143 | parameter can be any valid commit-ish. | |
144 | ||
8978d043 | 145 | In case of conflict, git-rebase will stop at the first problematic commit |
031321c6 SE |
146 | and leave conflict markers in the tree. You can use git diff to locate |
147 | the markers (<<<<<<) and make edits to resolve the conflict. For each | |
148 | file you edit, you need to tell git that the conflict has been resolved, | |
149 | typically this would be done with | |
150 | ||
151 | ||
d7f078b8 | 152 | git add <filename> |
031321c6 SE |
153 | |
154 | ||
155 | After resolving the conflict manually and updating the index with the | |
156 | desired resolution, you can continue the rebasing process with | |
157 | ||
158 | ||
159 | git rebase --continue | |
8978d043 | 160 | |
8978d043 BF |
161 | |
162 | Alternatively, you can undo the git-rebase with | |
163 | ||
031321c6 SE |
164 | |
165 | git rebase --abort | |
8978d043 | 166 | |
7fc9d69f JH |
167 | OPTIONS |
168 | ------- | |
69a60af5 CW |
169 | <newbase>:: |
170 | Starting point at which to create the new commits. If the | |
171 | --onto option is not specified, the starting point is | |
ea81fcc5 SP |
172 | <upstream>. May be any valid commit, and not just an |
173 | existing branch name. | |
69a60af5 | 174 | |
52a22d1e | 175 | <upstream>:: |
ea81fcc5 SP |
176 | Upstream branch to compare against. May be any valid commit, |
177 | not just an existing branch name. | |
7fc9d69f | 178 | |
228382ae | 179 | <branch>:: |
52a22d1e | 180 | Working branch; defaults to HEAD. |
7fc9d69f | 181 | |
031321c6 SE |
182 | --continue:: |
183 | Restart the rebasing process after having resolved a merge conflict. | |
184 | ||
185 | --abort:: | |
186 | Restore the original branch and abort the rebase operation. | |
187 | ||
58634dbf EW |
188 | --skip:: |
189 | Restart the rebasing process by skipping the current patch. | |
58634dbf EW |
190 | |
191 | --merge:: | |
192 | Use merging strategies to rebase. When the recursive (default) merge | |
193 | strategy is used, this allows rebase to be aware of renames on the | |
194 | upstream side. | |
195 | ||
196 | -s <strategy>, \--strategy=<strategy>:: | |
197 | Use the given merge strategy; can be supplied more than | |
198 | once to specify them in the order they should be tried. | |
199 | If there is no `-s` option, a built-in list of strategies | |
200 | is used instead (`git-merge-recursive` when merging a single | |
201 | head, `git-merge-octopus` otherwise). This implies --merge. | |
202 | ||
b758789c RS |
203 | -v, \--verbose:: |
204 | Display a diffstat of what changed upstream since the last rebase. | |
205 | ||
67dad687 MT |
206 | -C<n>:: |
207 | Ensure at least <n> lines of surrounding context match before | |
208 | and after each change. When fewer lines of surrounding | |
209 | context exist they all must match. By default no context is | |
210 | ever ignored. | |
211 | ||
1b1dce4b JS |
212 | -i, \--interactive:: |
213 | Make a list of the commits which are about to be rebased. Let the | |
214 | user edit that list before rebasing. | |
215 | ||
f09c9b8c JS |
216 | -p, \--preserve-merges:: |
217 | Instead of ignoring merges, try to recreate them. This option | |
218 | only works in interactive mode. | |
219 | ||
58634dbf EW |
220 | include::merge-strategies.txt[] |
221 | ||
031321c6 SE |
222 | NOTES |
223 | ----- | |
224 | When you rebase a branch, you are changing its history in a way that | |
225 | will cause problems for anyone who already has a copy of the branch | |
226 | in their repository and tries to pull updates from you. You should | |
227 | understand the implications of using 'git rebase' on a repository that | |
228 | you share. | |
229 | ||
230 | When the git rebase command is run, it will first execute a "pre-rebase" | |
231 | hook if one exists. You can use this hook to do sanity checks and | |
232 | reject the rebase if it isn't appropriate. Please see the template | |
233 | pre-rebase hook script for an example. | |
234 | ||
235 | You must be in the top directory of your project to start (or continue) | |
236 | a rebase. Upon completion, <branch> will be the current branch. | |
237 | ||
1b1dce4b JS |
238 | INTERACTIVE MODE |
239 | ---------------- | |
240 | ||
241 | Rebasing interactively means that you have a chance to edit the commits | |
242 | which are rebased. You can reorder the commits, and you can | |
243 | remove them (weeding out bad or otherwise unwanted patches). | |
244 | ||
245 | The interactive mode is meant for this type of workflow: | |
246 | ||
247 | 1. have a wonderful idea | |
248 | 2. hack on the code | |
249 | 3. prepare a series for submission | |
250 | 4. submit | |
251 | ||
252 | where point 2. consists of several instances of | |
253 | ||
254 | a. regular use | |
255 | 1. finish something worthy of a commit | |
256 | 2. commit | |
257 | b. independent fixup | |
258 | 1. realize that something does not work | |
259 | 2. fix that | |
260 | 3. commit it | |
261 | ||
262 | Sometimes the thing fixed in b.2. cannot be amended to the not-quite | |
263 | perfect commit it fixes, because that commit is buried deeply in a | |
264 | patch series. That is exactly what interactive rebase is for: use it | |
265 | after plenty of "a"s and "b"s, by rearranging and editing | |
266 | commits, and squashing multiple commits into one. | |
267 | ||
268 | Start it with the last commit you want to retain as-is: | |
269 | ||
270 | git rebase -i <after-this-commit> | |
271 | ||
272 | An editor will be fired up with all the commits in your current branch | |
273 | (ignoring merge commits), which come after the given commit. You can | |
274 | reorder the commits in this list to your heart's content, and you can | |
275 | remove them. The list looks more or less like this: | |
276 | ||
277 | ------------------------------------------- | |
278 | pick deadbee The oneline of this commit | |
279 | pick fa1afe1 The oneline of the next commit | |
280 | ... | |
281 | ------------------------------------------- | |
282 | ||
283 | The oneline descriptions are purely for your pleasure; `git-rebase` will | |
284 | not look at them but at the commit names ("deadbee" and "fa1afe1" in this | |
285 | example), so do not delete or edit the names. | |
286 | ||
287 | By replacing the command "pick" with the command "edit", you can tell | |
288 | `git-rebase` to stop after applying that commit, so that you can edit | |
289 | the files and/or the commit message, amend the commit, and continue | |
290 | rebasing. | |
291 | ||
292 | If you want to fold two or more commits into one, replace the command | |
293 | "pick" with "squash" for the second and subsequent commit. If the | |
294 | commits had different authors, it will attribute the squashed commit to | |
295 | the author of the last commit. | |
296 | ||
297 | In both cases, or when a "pick" does not succeed (because of merge | |
298 | errors), the loop will stop to let you fix things, and you can continue | |
299 | the loop with `git rebase --continue`. | |
300 | ||
301 | For example, if you want to reorder the last 5 commits, such that what | |
302 | was HEAD~4 becomes the new HEAD. To achieve that, you would call | |
303 | `git-rebase` like this: | |
304 | ||
305 | ---------------------- | |
306 | $ git rebase -i HEAD~5 | |
307 | ---------------------- | |
308 | ||
309 | And move the first patch to the end of the list. | |
310 | ||
f09c9b8c JS |
311 | You might want to preserve merges, if you have a history like this: |
312 | ||
313 | ------------------ | |
314 | X | |
315 | \ | |
316 | A---M---B | |
317 | / | |
318 | ---o---O---P---Q | |
319 | ------------------ | |
320 | ||
321 | Suppose you want to rebase the side branch starting at "A" to "Q". Make | |
322 | sure that the current HEAD is "B", and call | |
323 | ||
324 | ----------------------------- | |
325 | $ git rebase -i -p --onto Q O | |
326 | ----------------------------- | |
327 | ||
1b1dce4b | 328 | Authors |
7fc9d69f | 329 | ------ |
1b1dce4b JS |
330 | Written by Junio C Hamano <junkio@cox.net> and |
331 | Johannes E. Schindelin <johannes.schindelin@gmx.de> | |
7fc9d69f JH |
332 | |
333 | Documentation | |
334 | -------------- | |
335 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
336 | ||
337 | GIT | |
338 | --- | |
a7154e91 | 339 | Part of the gitlink:git[7] suite |