]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-rebase(1) |
2 | ============= | |
7fc9d69f JH |
3 | |
4 | NAME | |
5 | ---- | |
031321c6 | 6 | git-rebase - Rebase local commits to a new head |
7fc9d69f JH |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
69a60af5 | 10 | 'git-rebase' [--onto <newbase>] <upstream> [<branch>] |
7fc9d69f | 11 | |
cc120056 | 12 | 'git-rebase' --continue | --skip | --abort |
031321c6 | 13 | |
7fc9d69f JH |
14 | DESCRIPTION |
15 | ----------- | |
031321c6 SE |
16 | git-rebase replaces <branch> with a new branch of the same name. When |
17 | the --onto option is provided the new branch starts out with a HEAD equal | |
18 | to <newbase>, otherwise it is equal to <upstream>. It then attempts to | |
19 | create a new commit for each commit from the original <branch> that does | |
20 | not exist in the <upstream> branch. | |
69a60af5 | 21 | |
031321c6 SE |
22 | It is possible that a merge failure will prevent this process from being |
23 | completely automatic. You will have to resolve any such merge failure | |
cc120056 SE |
24 | and run `git rebase --continue`. Another option is to bypass the commit |
25 | that caused the merge failure with `git rebase --skip`. To restore the | |
26 | original <branch> and remove the .dotest working files, use the command | |
27 | `git rebase --abort` instead. | |
031321c6 SE |
28 | |
29 | Note that if <branch> is not specified on the command line, the currently | |
30 | checked out branch is used. | |
69a60af5 CW |
31 | |
32 | Assume the following history exists and the current branch is "topic": | |
33 | ||
031321c6 | 34 | ------------ |
69a60af5 CW |
35 | A---B---C topic |
36 | / | |
37 | D---E---F---G master | |
031321c6 | 38 | ------------ |
69a60af5 | 39 | |
228382ae | 40 | From this point, the result of either of the following commands: |
69a60af5 | 41 | |
031321c6 | 42 | |
69a60af5 CW |
43 | git-rebase master |
44 | git-rebase master topic | |
45 | ||
46 | would be: | |
47 | ||
031321c6 | 48 | ------------ |
69a60af5 CW |
49 | A'--B'--C' topic |
50 | / | |
51 | D---E---F---G master | |
031321c6 | 52 | ------------ |
69a60af5 | 53 | |
228382ae | 54 | While, starting from the same point, the result of either of the following |
69a60af5 CW |
55 | commands: |
56 | ||
57 | git-rebase --onto master~1 master | |
58 | git-rebase --onto master~1 master topic | |
59 | ||
60 | would be: | |
61 | ||
031321c6 | 62 | ------------ |
69a60af5 CW |
63 | A'--B'--C' topic |
64 | / | |
65 | D---E---F---G master | |
031321c6 | 66 | ------------ |
7fc9d69f | 67 | |
8978d043 | 68 | In case of conflict, git-rebase will stop at the first problematic commit |
031321c6 SE |
69 | and leave conflict markers in the tree. You can use git diff to locate |
70 | the markers (<<<<<<) and make edits to resolve the conflict. For each | |
71 | file you edit, you need to tell git that the conflict has been resolved, | |
72 | typically this would be done with | |
73 | ||
74 | ||
75 | git update-index <filename> | |
76 | ||
77 | ||
78 | After resolving the conflict manually and updating the index with the | |
79 | desired resolution, you can continue the rebasing process with | |
80 | ||
81 | ||
82 | git rebase --continue | |
8978d043 | 83 | |
8978d043 BF |
84 | |
85 | Alternatively, you can undo the git-rebase with | |
86 | ||
031321c6 SE |
87 | |
88 | git rebase --abort | |
8978d043 | 89 | |
7fc9d69f JH |
90 | OPTIONS |
91 | ------- | |
69a60af5 CW |
92 | <newbase>:: |
93 | Starting point at which to create the new commits. If the | |
94 | --onto option is not specified, the starting point is | |
95 | <upstream>. | |
96 | ||
52a22d1e LAS |
97 | <upstream>:: |
98 | Upstream branch to compare against. | |
7fc9d69f | 99 | |
228382ae | 100 | <branch>:: |
52a22d1e | 101 | Working branch; defaults to HEAD. |
7fc9d69f | 102 | |
031321c6 SE |
103 | --continue:: |
104 | Restart the rebasing process after having resolved a merge conflict. | |
105 | ||
106 | --abort:: | |
107 | Restore the original branch and abort the rebase operation. | |
108 | ||
109 | NOTES | |
110 | ----- | |
111 | When you rebase a branch, you are changing its history in a way that | |
112 | will cause problems for anyone who already has a copy of the branch | |
113 | in their repository and tries to pull updates from you. You should | |
114 | understand the implications of using 'git rebase' on a repository that | |
115 | you share. | |
116 | ||
117 | When the git rebase command is run, it will first execute a "pre-rebase" | |
118 | hook if one exists. You can use this hook to do sanity checks and | |
119 | reject the rebase if it isn't appropriate. Please see the template | |
120 | pre-rebase hook script for an example. | |
121 | ||
122 | You must be in the top directory of your project to start (or continue) | |
123 | a rebase. Upon completion, <branch> will be the current branch. | |
124 | ||
7fc9d69f JH |
125 | Author |
126 | ------ | |
127 | Written by Junio C Hamano <junkio@cox.net> | |
128 | ||
129 | Documentation | |
130 | -------------- | |
131 | Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. | |
132 | ||
133 | GIT | |
134 | --- | |
a7154e91 | 135 | Part of the gitlink:git[7] suite |
7fc9d69f | 136 |