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