blob: 63bd641a46f63e69a673c9bccc34b637c728c171 [file] [log] [blame]
<!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 -
Rebase local commits to a new head
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<p><em>git-rebase</em> [--onto &lt;newbase&gt;] &lt;upstream&gt; [&lt;branch&gt;]</p>
<p><em>git-rebase</em> --continue</p>
<p><em>git-rebase</em> --abort</p>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<p>git-rebase replaces &lt;branch&gt; with a new branch of the same name. When
the --onto option is provided the new branch starts out with a HEAD equal
to &lt;newbase&gt;, otherwise it is equal to &lt;upstream&gt;. It then attempts to
create a new commit for each commit from the original &lt;branch&gt; that does
not exist in the &lt;upstream&gt; 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>. If you can not resolve the merge
failure, running <tt>git rebase --abort</tt> will restore the original &lt;branch&gt;
and remove the working files found in the .dotest directory.</p>
<p>Note that if &lt;branch&gt; 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>While, starting from the same point, the result of either of the following
commands:</p>
<div class="literalblock">
<div class="content">
<pre><tt>git-rebase --onto master~1 master
git-rebase --onto master~1 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>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 (&lt;&lt;&lt;&lt;&lt;&lt;) 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 &lt;filename&gt;</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>
&lt;newbase&gt;
</dt>
<dd>
<p>
Starting point at which to create the new commits. If the
--onto option is not specified, the starting point is
&lt;upstream&gt;.
</p>
</dd>
<dt>
&lt;upstream&gt;
</dt>
<dd>
<p>
Upstream branch to compare against.
</p>
</dd>
<dt>
&lt;branch&gt;
</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>
</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, &lt;branch&gt; will be the current branch.</p>
</div>
<h2>Author</h2>
<div class="sectionbody">
<p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>
</div>
<h2>Documentation</h2>
<div class="sectionbody">
<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</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 02-May-2006 07:27:57 UTC
</div>
</div>
</body>
</html>