<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> | |
<meta name="generator" content="AsciiDoc 7.0.2" /> | |
<style type="text/css"> | |
/* Debug borders */ | |
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 { | |
/* | |
border: 1px solid red; | |
*/ | |
} | |
body { | |
margin: 1em 5% 1em 5%; | |
} | |
a { color: blue; } | |
a:visited { color: fuchsia; } | |
em { | |
font-style: italic; | |
} | |
strong { | |
font-weight: bold; | |
} | |
tt { | |
color: navy; | |
} | |
h1, h2, h3, h4, h5, h6 { | |
color: #527bbd; | |
font-family: sans-serif; | |
margin-top: 1.2em; | |
margin-bottom: 0.5em; | |
line-height: 1.3; | |
} | |
h1 { | |
border-bottom: 2px solid silver; | |
} | |
h2 { | |
border-bottom: 2px solid silver; | |
padding-top: 0.5em; | |
} | |
div.sectionbody { | |
font-family: serif; | |
margin-left: 0; | |
} | |
hr { | |
border: 1px solid silver; | |
} | |
p { | |
margin-top: 0.5em; | |
margin-bottom: 0.5em; | |
} | |
pre { | |
padding: 0; | |
margin: 0; | |
} | |
span#author { | |
color: #527bbd; | |
font-family: sans-serif; | |
font-weight: bold; | |
font-size: 1.2em; | |
} | |
span#email { | |
} | |
span#revision { | |
font-family: sans-serif; | |
} | |
div#footer { | |
font-family: sans-serif; | |
font-size: small; | |
border-top: 2px solid silver; | |
padding-top: 0.5em; | |
margin-top: 4.0em; | |
} | |
div#footer-text { | |
float: left; | |
padding-bottom: 0.5em; | |
} | |
div#footer-badges { | |
float: right; | |
padding-bottom: 0.5em; | |
} | |
div#preamble, | |
div.tableblock, div.imageblock, div.exampleblock, div.verseblock, | |
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
div.admonitionblock { | |
margin-right: 10%; | |
margin-top: 1.5em; | |
margin-bottom: 1.5em; | |
} | |
div.admonitionblock { | |
margin-top: 2.5em; | |
margin-bottom: 2.5em; | |
} | |
div.content { /* Block element content. */ | |
padding: 0; | |
} | |
/* Block element titles. */ | |
div.title, caption.title { | |
font-family: sans-serif; | |
font-weight: bold; | |
text-align: left; | |
margin-top: 1.0em; | |
margin-bottom: 0.5em; | |
} | |
div.title + * { | |
margin-top: 0; | |
} | |
td div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content div.title:first-child { | |
margin-top: 0.0em; | |
} | |
div.content + div.title { | |
margin-top: 0.0em; | |
} | |
div.sidebarblock > div.content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.listingblock > div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock > div.content { | |
padding-left: 2.0em; | |
} | |
div.quoteblock .attribution { | |
text-align: right; | |
} | |
div.admonitionblock .icon { | |
vertical-align: top; | |
font-size: 1.1em; | |
font-weight: bold; | |
text-decoration: underline; | |
color: #527bbd; | |
padding-right: 0.5em; | |
} | |
div.admonitionblock td.content { | |
padding-left: 0.5em; | |
border-left: 2px solid silver; | |
} | |
div.exampleblock > div.content { | |
border-left: 2px solid silver; | |
padding: 0.5em; | |
} | |
div.verseblock div.content { | |
white-space: pre; | |
} | |
div.imageblock div.content { padding-left: 0; } | |
div.imageblock img { border: 1px solid silver; } | |
span.image img { border-style: none; } | |
dl { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
dt { | |
margin-top: 0.5em; | |
margin-bottom: 0; | |
font-style: italic; | |
} | |
dd > *:first-child { | |
margin-top: 0; | |
} | |
ul, ol { | |
list-style-position: outside; | |
} | |
ol.olist2 { | |
list-style-type: lower-alpha; | |
} | |
div.tableblock > table { | |
border-color: #527bbd; | |
border-width: 3px; | |
} | |
thead { | |
font-family: sans-serif; | |
font-weight: bold; | |
} | |
tfoot { | |
font-weight: bold; | |
} | |
div.hlist { | |
margin-top: 0.8em; | |
margin-bottom: 0.8em; | |
} | |
td.hlist1 { | |
vertical-align: top; | |
font-style: italic; | |
padding-right: 0.8em; | |
} | |
td.hlist2 { | |
vertical-align: top; | |
} | |
@media print { | |
div#footer-badges { display: none; } | |
} | |
include::./stylesheets/xhtml11-manpage.css[] | |
/* Workarounds for IE6's broken and incomplete CSS2. */ | |
div.sidebar-content { | |
background: #ffffee; | |
border: 1px solid silver; | |
padding: 0.5em; | |
} | |
div.sidebar-title, div.image-title { | |
font-family: sans-serif; | |
font-weight: bold; | |
margin-top: 0.0em; | |
margin-bottom: 0.5em; | |
} | |
div.listingblock div.content { | |
border: 1px solid silver; | |
background: #f4f4f4; | |
padding: 0.5em; | |
} | |
div.quoteblock-content { | |
padding-left: 2.0em; | |
} | |
div.exampleblock-content { | |
border-left: 2px solid silver; | |
padding-left: 0.5em; | |
} | |
</style> | |
<title>git-rebase(1)</title> | |
</head> | |
<body> | |
<div id="header"> | |
<h1> | |
git-rebase(1) Manual Page | |
</h1> | |
<h2>NAME</h2> | |
<div class="sectionbody"> | |
<p>git-rebase - | |
Forward-port local commits to the updated upstream head | |
</p> | |
</div> | |
</div> | |
<h2>SYNOPSIS</h2> | |
<div class="sectionbody"> | |
<p><em>git-rebase</em> [-v] [--merge] [--onto <newbase>] <upstream> [<branch>]</p> | |
<p><em>git-rebase</em> --continue | --skip | --abort</p> | |
</div> | |
<h2>DESCRIPTION</h2> | |
<div class="sectionbody"> | |
<p>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.</p> | |
<p>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 <tt>git rebase --continue</tt>. Another option is to bypass the commit | |
that caused the merge failure with <tt>git rebase --skip</tt>. To restore the | |
original <branch> and remove the .dotest working files, use the command | |
<tt>git rebase --abort</tt> instead.</p> | |
<p>Note that if <branch> is not specified on the command line, the currently | |
checked out branch is used.</p> | |
<p>Assume the following history exists and the current branch is "topic":</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> A---B---C topic | |
/ | |
D---E---F---G master</tt></pre> | |
</div></div> | |
<p>From this point, the result of either of the following commands:</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git-rebase master | |
git-rebase master topic</tt></pre> | |
</div></div> | |
<p>would be:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> A'--B'--C' topic | |
/ | |
D---E---F---G master</tt></pre> | |
</div></div> | |
<p>The latter form is just a short-hand of <tt>git checkout topic</tt> | |
followed by <tt>git rebase master</tt>.</p> | |
<p>Here is how you would transplant a topic branch based on one | |
branch to another, to pretend that you forked the topic branch | |
from the latter branch, using <tt>rebase --onto</tt>.</p> | |
<p>First let's assume your <em>topic</em> is based on branch <em>next</em>. | |
For example feature developed in <em>topic</em> depends on some | |
functionality which is found in <em>next</em>.</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> o---o---o---o---o master | |
\ | |
o---o---o---o---o next | |
\ | |
o---o---o topic</tt></pre> | |
</div></div> | |
<p>We would want to make <em>topic</em> forked from branch <em>master</em>, | |
for example because the functionality <em>topic</em> branch depend on | |
got merged into more stable <em>master</em> branch, like this:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> o---o---o---o---o master | |
| \ | |
| o'--o'--o' topic | |
\ | |
o---o---o---o---o next</tt></pre> | |
</div></div> | |
<p>We can get this using the following command:</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git-rebase --onto master next topic</tt></pre> | |
</div></div> | |
<p>Another example of --onto option is to rebase part of a | |
branch. If we have the following situation:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> H---I---J topicB | |
/ | |
E---F---G topicA | |
/ | |
A---B---C---D master</tt></pre> | |
</div></div> | |
<p>then the command</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git-rebase --onto master topicA topicB</tt></pre> | |
</div></div> | |
<p>would result in:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> H'--I'--J' topicB | |
/ | |
| E---F---G topicA | |
|/ | |
A---B---C---D master</tt></pre> | |
</div></div> | |
<p>This is useful when topicB does not depend on topicA.</p> | |
<p>A range of commits could also be removed with rebase. If we have | |
the following situation:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> E---F---G---H---I---J topicA</tt></pre> | |
</div></div> | |
<p>then the command</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git-rebase --onto topicA~5 topicA~2 topicA</tt></pre> | |
</div></div> | |
<p>would result in the removal of commits F and G:</p> | |
<div class="listingblock"> | |
<div class="content"> | |
<pre><tt> E---H'---I'---J' topicA</tt></pre> | |
</div></div> | |
<p>This is useful if F and G were flawed in some way, or should not be | |
part of topicA. Note that the argument to --onto and the <upstream> | |
parameter can be any valid commit-ish.</p> | |
<p>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</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git update-index <filename></tt></pre> | |
</div></div> | |
<p>After resolving the conflict manually and updating the index with the | |
desired resolution, you can continue the rebasing process with</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git rebase --continue</tt></pre> | |
</div></div> | |
<p>Alternatively, you can undo the git-rebase with</p> | |
<div class="literalblock"> | |
<div class="content"> | |
<pre><tt>git rebase --abort</tt></pre> | |
</div></div> | |
</div> | |
<h2>OPTIONS</h2> | |
<div class="sectionbody"> | |
<dl> | |
<dt> | |
<newbase> | |
</dt> | |
<dd> | |
<p> | |
Starting point at which to create the new commits. If the | |
--onto option is not specified, the starting point is | |
<upstream>. May be any valid commit, and not just an | |
existing branch name. | |
</p> | |
</dd> | |
<dt> | |
<upstream> | |
</dt> | |
<dd> | |
<p> | |
Upstream branch to compare against. May be any valid commit, | |
not just an existing branch name. | |
</p> | |
</dd> | |
<dt> | |
<branch> | |
</dt> | |
<dd> | |
<p> | |
Working branch; defaults to HEAD. | |
</p> | |
</dd> | |
<dt> | |
--continue | |
</dt> | |
<dd> | |
<p> | |
Restart the rebasing process after having resolved a merge conflict. | |
</p> | |
</dd> | |
<dt> | |
--abort | |
</dt> | |
<dd> | |
<p> | |
Restore the original branch and abort the rebase operation. | |
</p> | |
</dd> | |
<dt> | |
--skip | |
</dt> | |
<dd> | |
<p> | |
Restart the rebasing process by skipping the current patch. | |
</p> | |
</dd> | |
<dt> | |
--merge | |
</dt> | |
<dd> | |
<p> | |
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. | |
</p> | |
</dd> | |
<dt> | |
-s <strategy>, --strategy=<strategy> | |
</dt> | |
<dd> | |
<p> | |
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 <tt>-s</tt> option, a built-in list of strategies | |
is used instead (<tt>git-merge-recursive</tt> when merging a single | |
head, <tt>git-merge-octopus</tt> otherwise). This implies --merge. | |
</p> | |
</dd> | |
<dt> | |
-v, --verbose | |
</dt> | |
<dd> | |
<p> | |
Display a diffstat of what changed upstream since the last rebase. | |
</p> | |
</dd> | |
</dl> | |
</div> | |
<h2>MERGE STRATEGIES</h2> | |
<div class="sectionbody"> | |
<dl> | |
<dt> | |
resolve | |
</dt> | |
<dd> | |
<p> | |
This can only resolve two heads (i.e. the current branch | |
and another branch you pulled from) using 3-way merge | |
algorithm. It tries to carefully detect criss-cross | |
merge ambiguities and is considered generally safe and | |
fast. | |
</p> | |
</dd> | |
<dt> | |
recursive | |
</dt> | |
<dd> | |
<p> | |
This can only resolve two heads using 3-way merge | |
algorithm. When there are more than one common | |
ancestors that can be used for 3-way merge, it creates a | |
merged tree of the common ancestors and uses that as | |
the reference tree for the 3-way merge. This has been | |
reported to result in fewer merge conflicts without | |
causing mis-merges by tests done on actual merge commits | |
taken from Linux 2.6 kernel development history. | |
Additionally this can detect and handle merges involving | |
renames. This is the default merge strategy when | |
pulling or merging one branch. | |
</p> | |
</dd> | |
<dt> | |
octopus | |
</dt> | |
<dd> | |
<p> | |
This resolves more than two-head case, but refuses to do | |
complex merge that needs manual resolution. It is | |
primarily meant to be used for bundling topic branch | |
heads together. This is the default merge strategy when | |
pulling or merging more than one branches. | |
</p> | |
</dd> | |
<dt> | |
ours | |
</dt> | |
<dd> | |
<p> | |
This resolves any number of heads, but the result of the | |
merge is always the current branch head. It is meant to | |
be used to supersede old development history of side | |
branches. | |
</p> | |
</dd> | |
</dl> | |
</div> | |
<h2>NOTES</h2> | |
<div class="sectionbody"> | |
<p>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 <em>git rebase</em> on a repository that | |
you share.</p> | |
<p>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.</p> | |
<p>You must be in the top directory of your project to start (or continue) | |
a rebase. Upon completion, <branch> will be the current branch.</p> | |
</div> | |
<h2>Author</h2> | |
<div class="sectionbody"> | |
<p>Written by Junio C Hamano <junkio@cox.net></p> | |
</div> | |
<h2>Documentation</h2> | |
<div class="sectionbody"> | |
<p>Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.</p> | |
</div> | |
<h2>GIT</h2> | |
<div class="sectionbody"> | |
<p>Part of the <a href="git.html">git(7)</a> suite</p> | |
</div> | |
<div id="footer"> | |
<div id="footer-text"> | |
Last updated 06-Feb-2007 00:09:25 UTC | |
</div> | |
</div> | |
</body> | |
</html> |