[PATCH] doc: pull: fix rebase=false documentation
- From
Felipe Contreras <felipe.contreras@gmail.com>
- Date
- Jul 21, 2021, 22:15 UTC
- Message-ID
- <20210721221545.1878514-1-felipe.contreras@gmail.com>
The behavior of --rebase=false is obviously wrong (as has been discussed in big threads before [1] [2]): we want our users to merge their current branch into the upstream branch, but this is not what the code is currently doing; it does the *opposite*.
Fix the documentation so that we explain what the code actually does, not what we wish it did.
[1] https://lore.kernel.org/git/20130522115042.GA20649@inner.h.apk.li/ [2] https://lore.kernel.org/git/4ay6w9i74cygt6ii1b0db7wg.1398433713382@email.android.com/
Cc: Stephen Haberman <stephen@exigencecorp.com> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> --- Documentation/git-pull.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 5c3fb67c01..7f4b2d1982 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -117,7 +117,7 @@ When set to `preserve` (deprecated in favor of `merges`), rebase with the `--preserve-merges` option passed to `git rebase` so that locally created merge commits will not be flattened. + -When false, merge the current branch into the upstream branch. +When false, merge the upstream branch into the current branch. + When `interactive`, enable the interactive mode of rebase. +
-- 2.32.0.40.gb9b36f9b52