Documentation/git-rebase.txt: document when --fork-point is auto-enabled
Running "git rebase" without giving a specific commit with respect to which the operation is done enables --fork-point mode, while telling the command to rebase with respect to a specific commit, i.e. "git rebase <upstream>" does not. This was not mentioned in the DESCRIPTION section of the manual page, even though the case of omitted <upstream> was otherwise discussed. That in turn made actual behavior of vanilla "git rebase" hardly discoverable. While we are at it, clarify the --fork-point description itself as well. Signed-off-by: Sergey Organov <sorganov@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Sergey Organov committed
Sep 18, 2014 at 23:03 UTC
f51a48ec3aacaa01357c891c79dfc45aae0efeff
1 file changed
+19
-12
Documentation/git-rebase.txt
+19
-12
@@ -21,15 +21,17 @@ If <branch> is specified, 'git rebase' will perform an automatic
21
it remains on the current branch.
22
23
If <upstream> is not specified, the upstream configured in
24
-branch.<name>.remote and branch.<name>.merge options will be used; see
25
-linkgit:git-config[1] for details. If you are currently not on any
26
-branch or if the current branch does not have a configured upstream,
27
-the rebase will abort.
24
+branch.<name>.remote and branch.<name>.merge options will be used (see
25
+linkgit:git-config[1] for details) and the `--fork-point` option is
26
+assumed. If you are currently not on any branch or if the current
27
+branch does not have a configured upstream, the rebase will abort.
28
29
All changes made by commits in the current branch but that are not
30
in <upstream> are saved to a temporary area. This is the same set
31
-of commits that would be shown by `git log <upstream>..HEAD` (or
32
-`git log HEAD`, if --root is specified).
31
+of commits that would be shown by `git log <upstream>..HEAD`; or by
32
+`git log 'fork_point'..HEAD`, if `--fork-point` is active (see the
33
+description on `--fork-point` below); or by `git log HEAD`, if the
34
+`--root` option is specified.
35
36
The current branch is reset to <upstream>, or <newbase> if the
37
--onto option was supplied. This has the exact same effect as
@@ -326,13 +328,18 @@ link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details)
328
329
--fork-point::
330
--no-fork-point::
329
- Use 'git merge-base --fork-point' to find a better common ancestor
330
- between `upstream` and `branch` when calculating which commits have
331
- have been introduced by `branch` (see linkgit:git-merge-base[1]).
331
+ Use reflog to find a better common ancestor between <upstream>
332
+ and <branch> when calculating which commits have been
333
+ introduced by <branch>.
334
+
333
-If no non-option arguments are given on the command line, then the default is
334
-`--fork-point @{u}` otherwise the `upstream` argument is interpreted literally
335
-unless the `--fork-point` option is specified.
335
+When --fork-point is active, 'fork_point' will be used instead of
336
+<upstream> to calculate the set of commits to rebase, where
337
+'fork_point' is the result of `git merge-base --fork-point <upstream>
338
+<branch>` command (see linkgit:git-merge-base[1]). If 'fork_point'
339
+ends up being empty, the <upstream> will be used as a fallback.
340
++
341
+If either <upstream> or --root is given on the command line, then the
342
+default is `--no-fork-point`, otherwise the default is `--fork-point`.
343
344
--ignore-whitespace::
345
--whitespace=<option>::