Dragan Simic <dsimic@xxxxxxxxxxx> writes:
> Mention in the documentation that --rebase defaults to false.
I am not quite sure if this is an improvement, though.
It is true that, if you do not have any of your own funny
configuration, your "git pull" will *not* rebase.
But that is "if you do not give the --rebase option, you do not
trigger the rebase action". Which is quite natural, but it is
different from what you wrote above, isn't it?
When people say "the default for `--rebase` is false", they mean
this:
I can say "git pull --rebase=<kind>" to specify how my current
branch is rebased on top of the upstream. But if I do not
specify the <kind>, i.e. "git pull --rebase", the command will
act as if I gave 'false' as the <kind>.
At least, I would think that is what the word "default" means.
And I would be surprised if the "default" in that sense is 'false';
isn't the default <kind> 'true' --- meaning "perform the plain
vanilla 'git rebase'", unless you explicitly asked for 'merges',
'interactive' or 'false'?
After the context of the hunk your patch touches, there is a
description on `pull.rebase`. Down there, if you do not set
`pull.rebase` or `branch.<name>.rebase` for the current branch at
all, the system acts as if you had `false` for these variables. In
other words, the default for these variables is `false`, meaning "do
not rebase, just merge". But the default option argument for the
`--rebase` option given without argument would not be `false`, I
would think.
> Signed-off-by: Dragan Simic <dsimic@xxxxxxxxxxx>
> ---
> Documentation/git-pull.txt | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
> index 0e14f8b5b2..d28790388e 100644
> --- a/Documentation/git-pull.txt
> +++ b/Documentation/git-pull.txt
> @@ -116,7 +116,8 @@ When set to `merges`, rebase using `git rebase --rebase-merges` so that
> the local merge commits are included in the rebase (see
> linkgit:git-rebase[1] for details).
> +
> -When false, merge the upstream branch into the current branch.
> +When false, merge the upstream branch into the current branch. This is
> +the default.
> +
> When `interactive`, enable the interactive mode of rebase.
> +
