Skip to content

Commit e9468ad

Browse files
committed
doc: git-rebase: update discussion of internals
- make it clearer that we're talking about a multistep process - give a more technically accurate description how rebase works with the merge backend. - condense the explanation of how git rebase skips commits with the same textual changes into a single bullet point and remove the explanatory diagram. Lots of things which are more complicated are already being explained without a diagram. - remove the explanation of how exactly `--fork-point` and `--root` work since that information is in the OPTIONS section - put all discussion of `ORIG_HEAD` inside the note Signed-off-by: Julia Evans <[email protected]>
1 parent 4686417 commit e9468ad

File tree

1 file changed

+23
-43
lines changed

1 file changed

+23
-43
lines changed

Documentation/git-rebase.adoc

Lines changed: 23 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -68,51 +68,31 @@ linkgit:git-config[1] for details) and the `--fork-point` option is
6868
assumed. If you are currently not on any branch or if the current
6969
branch does not have a configured upstream, the rebase will abort.
7070

71-
All changes made by commits in the current branch but that are not
72-
in `<upstream>` are saved to a temporary area. This is the same set
73-
of commits that would be shown by `git log <upstream>..HEAD`; or by
74-
`git log 'fork_point'..HEAD`, if `--fork-point` is active (see the
75-
description on `--fork-point` below); or by `git log HEAD`, if the
76-
`--root` option is specified.
77-
78-
The current branch is reset to `<upstream>` or `<newbase>` if the
79-
`--onto` option was supplied. This has the exact same effect as
80-
`git reset --hard <upstream>` (or `<newbase>`). `ORIG_HEAD` is set
81-
to point at the tip of the branch before the reset.
71+
Here is a more detailed description of what `git rebase <upstream>` does:
72+
73+
1. Make a list of all commits in the current branch that are not in
74+
`<upstream>`. This is the same set of commits that would be shown by `git log
75+
<upstream>..HEAD`. You can use `--fork-point` or `--root` to change how this
76+
list of commits is constructed.
77+
2. Check whether any of those commits are duplicates of commits already
78+
in `<upstream>`, remove them from the list, and print out a warning about
79+
each removed commit. You can use `--reapply-cherry-picks` to include
80+
duplicate commits.
81+
3. Check out `<upstream>` (or `<newbase>` if the `--onto` option was
82+
supplied) with the equivalent of `git checkout --detach <upstream>`.
83+
4. Replay the commits, one by one, in order. This is similar to running
84+
`git cherry-pick <commit>` for each commit. See REBASING MERGES for how merges
85+
are handled.
86+
5. Update your branch to point to the final commit with the equivalent
87+
of `git switch -C <branch>`.
8288
8389
[NOTE]
84-
`ORIG_HEAD` is not guaranteed to still point to the previous branch tip
85-
at the end of the rebase if other commands that write that pseudo-ref
86-
(e.g. `git reset`) are used during the rebase. The previous branch tip,
87-
however, is accessible using the reflog of the current branch
88-
(i.e. `@{1}`, see linkgit:gitrevisions[7]).
89-
90-
The commits that were previously saved into the temporary area are
91-
then reapplied to the current branch, one by one, in order. Note that
92-
any commits in `HEAD` which introduce the same textual changes as a commit
93-
in `HEAD..<upstream>` are omitted (i.e., a patch already accepted upstream
94-
with a different commit message or timestamp will be skipped).
95-
96-
If the upstream branch already contains a change you have made (e.g.,
97-
because you mailed a patch which was applied upstream), then that commit
98-
will be skipped and warnings will be issued (if the 'merge' backend is
99-
used). For example, running `git rebase master` on the following
100-
history (in which `A'` and `A` introduce the same set of changes, but
101-
have different committer information):
102-
103-
------------
104-
A---B---C topic
105-
/
106-
D---E---A'---F master
107-
------------
108-
109-
will result in:
110-
111-
------------
112-
B'---C' topic
113-
/
114-
D---E---A'---F master
115-
------------
90+
When starting the rebase, `ORIG_HEAD` is set to point to the commit at the tip
91+
of the to-be-rebased branch. However, `ORIG_HEAD` is not guaranteed to still
92+
point to that commit at the end of the rebase if other commands that change
93+
`ORIG_HEAD` (like `git reset`) are used during the rebase. The previous branch
94+
tip, however, is accessible using the reflog of the current branch (i.e. `@{1}`,
95+
see linkgit:gitrevisions[7].
11696

11797
MODE OPTIONS
11898
------------

0 commit comments

Comments
 (0)