From: Sergey Organov Date: Thu, 18 Sep 2014 19:03:25 GMT Subject: [PATCH v2] Documentation/git-rebase.txt: discuss --fork-point assumption of vanilla "git rebase" in DESCRIPTION. Message-ID: <87k34mn0ht.fsf@osv.gnss.ru> In-Reply-To: <87r3z72wiu.fsf@osv.gnss.ru> Vanilla "git rebase" defaults to --fork-point that in some cases makes behavior very different from "git rebase ", where --no-fork-point is assumed. This fact was not mentioned in the DESCRIPTION section of the manual page, even though the case of omitted 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 --- As asked by Junio C Hamano , the newly introduced 'fork_point' term has been described. Documentation/git-rebase.txt | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 4138554..2e6f125 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -21,15 +21,17 @@ If is specified, 'git rebase' will perform an automatic it remains on the current branch. If is not specified, the upstream configured in -branch..remote and branch..merge options will be used; see -linkgit:git-config[1] for details. If you are currently not on any -branch or if the current branch does not have a configured upstream, -the rebase will abort. +branch..remote and branch..merge options will be used (see +linkgit:git-config[1] for details) and the `--fork-point` option is +assumed. If you are currently not on any branch or if the current +branch does not have a configured upstream, the rebase will abort. All changes made by commits in the current branch but that are not in are saved to a temporary area. This is the same set -of commits that would be shown by `git log ..HEAD` (or -`git log HEAD`, if --root is specified). +of commits that would be shown by `git log ..HEAD`; or by +`git log 'fork_point'..HEAD`, if --fork-point is either specified or +assumed (see --fork-point description below); or by `git log HEAD`, if +--root is specified. The current branch is reset to , or if the --onto option was supplied. This has the exact same effect as @@ -327,13 +329,18 @@ link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for details) --fork-point:: --no-fork-point:: - Use 'git merge-base --fork-point' to find a better common ancestor - between `upstream` and `branch` when calculating which commits have - have been introduced by `branch` (see linkgit:git-merge-base[1]). + Use reflog to find a better common ancestor between + and when calculating which commits have been + introduced by . + -If no non-option arguments are given on the command line, then the default is -`--fork-point @{u}` otherwise the `upstream` argument is interpreted literally -unless the `--fork-point` option is specified. +When --fork-point is active, 'fork_point' will be used instead of + to calculate the set of commits to rebase, where +'fork_point' is the result of `git merge-base --fork-point +` command (see linkgit:git-merge-base[1]). If 'fork_point' +ends up being empty, the will be used instead. ++ +If either or --root is given on the command line, then the +default is `--no-fork-point`, otherwise the default is `--fork-point`. --ignore-whitespace:: --whitespace=