mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation/git-rebase.txt: document when --fork-point is auto-enabled

Browse Source 
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>
This commit is contained in:
Sergey Organov
2014-09-18 23:03:25 +04:00
committed by Junio C Hamano
parent d31f3ad23d
commit f51a48ec3a
1 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
Documentation/git-rebase.txt
View File

@ -21,15 +21,17 @@ If <branch> is specified, 'git rebase' will perform an automatic
it remains on the current branch. it remains on the current branch.
If <upstream> is not specified, the upstream configured in If <upstream> is not specified, the upstream configured in
branch.<name>.remote and branch.<name>.merge options will be used; see branch.<name>.remote and branch.<name>.merge options will be used (see
linkgit:git-config[1] for details. If you are currently not on any linkgit:git-config[1] for details) and the `--fork-point` option is
branch or if the current branch does not have a configured upstream, assumed. If you are currently not on any branch or if the current
the rebase will abort. branch does not have a configured upstream, the rebase will abort.
All changes made by commits in the current branch but that are not All changes made by commits in the current branch but that are not
in <upstream> are saved to a temporary area. This is the same set in <upstream> are saved to a temporary area. This is the same set
of commits that would be shown by `git log <upstream>..HEAD` (or of commits that would be shown by `git log <upstream>..HEAD`; or by
`git log HEAD`, if --root is specified). `git log 'fork_point'..HEAD`, if `--fork-point` is active (see the
description on `--fork-point` below); or by `git log HEAD`, if the
`--root` option is specified.
The current branch is reset to <upstream>, or <newbase> if the The current branch is reset to <upstream>, or <newbase> if the
--onto option was supplied. This has the exact same effect as --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)
--fork-point:: --fork-point::
--no-fork-point:: --no-fork-point::
Use 'git merge-base --fork-point' to find a better common ancestor Use reflog to find a better common ancestor between <upstream>
between `upstream` and `branch` when calculating which commits have and <branch> when calculating which commits have been
have been introduced by `branch` (see linkgit:git-merge-base[1]). introduced by <branch>.
+ +
If no non-option arguments are given on the command line, then the default is When --fork-point is active, 'fork_point' will be used instead of
`--fork-point @{u}` otherwise the `upstream` argument is interpreted literally <upstream> to calculate the set of commits to rebase, where
unless the `--fork-point` option is specified. 'fork_point' is the result of `git merge-base --fork-point <upstream>
<branch>` command (see linkgit:git-merge-base[1]). If 'fork_point'
ends up being empty, the <upstream> will be used as a fallback.
+
If either <upstream> or --root is given on the command line, then the
default is `--no-fork-point`, otherwise the default is `--fork-point`.
--ignore-whitespace:: --ignore-whitespace::
--whitespace=<option>:: --whitespace=<option>::