core-tutorial.txt: escape asterisk
[git/jrn.git] / Documentation / git-rebase.txt
blob4a7e67a4d2241a82a564734d64789e6ee13c8330
1 git-rebase(1)
2 =============
4 NAME
5 ----
6 git-rebase - Rebase local commits to new upstream head
8 SYNOPSIS
9 --------
10 'git-rebase' [--onto <newbase>] <upstream> [<branch>]
12 DESCRIPTION
13 -----------
14 git-rebase applies to <upstream> (or optionally to <newbase>) commits
15 from <branch> that do not appear in <upstream>. When <branch> is not
16 specified it defaults to the current branch (HEAD).
18 When git-rebase is complete, <branch> will be updated to point to the
19 newly created line of commit objects, so the previous line will not be
20 accessible unless there are other references to it already.
22 Assume the following history exists and the current branch is "topic":
24           A---B---C topic
25          /
26     D---E---F---G master
28 From this point, the result of either of the following commands:
30     git-rebase master
31     git-rebase master topic
33 would be:
35                   A'--B'--C' topic
36                  /
37     D---E---F---G master
39 While, starting from the same point, the result of either of the following
40 commands:
42     git-rebase --onto master~1 master
43     git-rebase --onto master~1 master topic
45 would be:
47               A'--B'--C' topic
48              /
49     D---E---F---G master
51 In case of conflict, git-rebase will stop at the first problematic commit
52 and leave conflict markers in the tree.  After resolving the conflict manually
53 and updating the index with the desired resolution, you can continue the
54 rebasing process with
56     git am --resolved --3way
58 Alternatively, you can undo the git-rebase with
60     git reset --hard ORIG_HEAD
61     rm -r .dotest
63 OPTIONS
64 -------
65 <newbase>::
66         Starting point at which to create the new commits. If the
67         --onto option is not specified, the starting point is
68         <upstream>.
70 <upstream>::
71         Upstream branch to compare against.
73 <branch>::
74         Working branch; defaults to HEAD.
76 Author
77 ------
78 Written by Junio C Hamano <junkio@cox.net>
80 Documentation
81 --------------
82 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
84 GIT
85 ---
86 Part of the gitlink:git[7] suite