summaryrefslogtreecommitdiffstats
path: root/git-rebase.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junio@hera.kernel.org>2006-02-22 10:44:55 +0000
committerJunio C Hamano <junio@hera.kernel.org>2006-02-22 10:44:55 +0000
commit7e9f6b7094a99335837f79e33c7723ff516dc53b (patch)
tree63562096a6b1da75e4f1058e5c5d52a0296f0c20 /git-rebase.txt
parentdb8c6ec4d67d54e932ff289f974e38a59a134702 (diff)
downloadgit-htmldocs-7e9f6b7094a99335837f79e33c7723ff516dc53b.tar.gz
Autogenerated HTML docs for v1.2.2-g50319
Diffstat (limited to 'git-rebase.txt')
-rw-r--r--git-rebase.txt44
1 files changed, 42 insertions, 2 deletions
diff --git a/git-rebase.txt b/git-rebase.txt
index 16c158f43..f037d1280 100644
--- a/git-rebase.txt
+++ b/git-rebase.txt
@@ -7,14 +7,54 @@ git-rebase - Rebase local commits to new upstream head.
SYNOPSIS
--------
-'git-rebase' <upstream> [<head>]
+'git-rebase' [--onto <newbase>] <upstream> [<branch>]
DESCRIPTION
-----------
-Rebases local commits to the new head of the upstream tree.
+git-rebase applies to <upstream> (or optionally to <newbase>) commits
+from <branch> that do not appear in <upstream>. When <branch> is not
+specified it defaults to the current branch (HEAD).
+
+When git-rebase is complete, <branch> will be updated to point to the
+newly created line of commit objects, so the previous line will not be
+accessible unless there are other references to it already.
+
+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 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 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
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.