rebase: update documentation for --root
Since the new option depends on --onto and omission of <upstream>, use a separate invocation style, and omit most options to save space. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Thomas Rast committed
Jan 2, 2009 at 23:28 UTC
be4966210125f558864368a666ebde67bed92151
1 file changed
+16
-5
Documentation/git-rebase.txt
+16
-5
@@ -8,10 +8,11 @@ git-rebase - Forward-port local commits to the updated upstream head
8
SYNOPSIS
9
--------
10
[verse]
11
-'git rebase' [-i | --interactive] [-v | --verbose] [-m | --merge]
12
- [-s <strategy> | --strategy=<strategy>] [--no-verify]
13
- [-C<n>] [ --whitespace=<option>] [-p | --preserve-merges]
14
- [--onto <newbase>] <upstream> [<branch>]
11
+'git rebase' [-i | --interactive] [options] [--onto <newbase>]
12
+ <upstream> [<branch>]
13
+'git rebase' [-i | --interactive] [options] --onto <newbase>
14
+ --root [<branch>]
15
+
16
'git rebase' --continue | --skip | --abort
17
18
DESCRIPTION
@@ -22,7 +23,8 @@ it remains on the current branch.
23
24
All changes made by commits in the current branch but that are not
25
in <upstream> are saved to a temporary area. This is the same set
25
-of commits that would be shown by `git log <upstream>..HEAD`.
26
+of commits that would be shown by `git log <upstream>..HEAD` (or
27
+`git log HEAD`, if --root is specified).
28
29
The current branch is reset to <upstream>, or <newbase> if the
30
--onto option was supplied. This has the exact same effect as
@@ -255,6 +257,15 @@ OPTIONS
257
--preserve-merges::
258
Instead of ignoring merges, try to recreate them.
259
260
+--root::
261
+ Rebase all commits reachable from <branch>, instead of
262
+ limiting them with an <upstream>. This allows you to rebase
263
+ the root commit(s) on a branch. Must be used with --onto, and
264
+ will skip changes already contained in <newbase> (instead of
265
+ <upstream>). When used together with --preserve-merges, 'all'
266
+ root commits will be rewritten to have <newbase> as parent
267
+ instead.
268
+
269
include::merge-strategies.txt[]
270
271
NOTES