From: Felipe Contreras <felipe.contreras@gmail.com>
To: git@vger.kernel.org
Cc: "Vít Ondruch" <vondruch@redhat.com>,
"Jacob Keller" <jacob.keller@gmail.com>,
"Alex Henrie" <alexhenrie24@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>, "Jeff King" <peff@peff.net>,
"Elijah Newren" <newren@gmail.com>,
"Felipe Contreras" <felipe.contreras@gmail.com>
Subject: [PATCH 1/2] doc: pull: explain what is a fast-forward
Date: Mon, 21 Jun 2021 12:52:33 -0500 [thread overview]
Message-ID: <20210621175234.1079004-2-felipe.contreras@gmail.com> (raw)
In-Reply-To: <20210621175234.1079004-1-felipe.contreras@gmail.com>
We want users to know what is a fast-forward in order to understand the
default warning.
Let's expand the explanation in order to cover both the simple, and the
complex cases with as much detail as possible.
Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
Documentation/git-pull.txt | 41 ++++++++++++++++++++++++++++++++------
1 file changed, 35 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 5c3fb67c01..142df1c4a1 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -41,16 +41,41 @@ Assume the following history exists and the current branch is
------------
A---B---C master on origin
/
- D---E---F---G master
+ D---E master
^
origin/master in your repository
------------
Then "`git pull`" will fetch and replay the changes from the remote
`master` branch since it diverged from the local `master` (i.e., `E`)
-until its current commit (`C`) on top of `master` and record the
-result in a new commit along with the names of the two parent commits
-and a log message from the user describing the changes.
+until its current commit (`C`) on top of `master`.
+
+After the remote changes have been synchronized, the local `master` will
+be fast-forwarded to the same commit as the remote one, therefore
+creating a linear history.
+
+------------
+ D---E---A---B---C master, origin/master
+------------
+
+However, a non-fast-forward case looks very different:
+
+------------
+ A---B---C origin/master
+ /
+ D---E---F---G master
+------------
+
+If there are additional changes in the local `master`, it's
+not possible to fast-forward, so a decision must be made how to
+synchronize the local, and remote brances.
+
+In these situations `git pull` will warn you about your possible
+options, which are either merge (`--no-rebase`), or rebase (`--rebase`).
+However, by default it will continue doing a merge.
+
+A merge will create a new commit with two parent commits (`G` and `C`)
+and a log message describing the changes, which you can edit.
------------
A---B---C origin/master
@@ -58,8 +83,11 @@ and a log message from the user describing the changes.
D---E---F---G---H master
------------
+Once the merge commit is created (`H`), your local `master` branch has
+incorporated the changes of the remote `master` branch.
+
See linkgit:git-merge[1] for details, including how conflicts
-are presented and handled.
+are presented and handled, and also linkgit:git-rebase[1].
In Git 1.7.0 or later, to cancel a conflicting merge, use
`git reset --merge`. *Warning*: In older versions of Git, running 'git pull'
@@ -248,7 +276,8 @@ version.
SEE ALSO
--------
-linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]
+linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-rebase[1],
+linkgit:git-config[1]
GIT
---
--
2.32.0
next prev parent reply other threads:[~2021-06-21 17:54 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-21 17:52 [PATCH 0/2] pull: documentation improvements Felipe Contreras
2021-06-21 17:52 ` Felipe Contreras [this message]
2021-06-22 5:51 ` [PATCH 1/2] doc: pull: explain what is a fast-forward Bagas Sanjaya
2021-06-23 1:11 ` Felipe Contreras
2021-06-24 14:21 ` Philip Oakley
2021-06-24 14:31 ` Felipe Contreras
2021-06-24 16:59 ` Philip Oakley
2021-06-24 19:05 ` Felipe Contreras
2021-06-24 22:07 ` Philip Oakley
2021-06-24 23:41 ` Felipe Contreras
2021-06-25 9:12 ` Ævar Arnfjörð Bjarmason
2021-06-25 10:47 ` Felipe Contreras
2021-06-25 10:59 ` Ævar Arnfjörð Bjarmason
2021-06-25 15:49 ` Felipe Contreras
2021-06-25 16:53 ` Kerry, Richard
2021-06-25 17:34 ` Felipe Contreras
2021-06-25 21:36 ` Felipe Contreras
2021-06-21 17:52 ` [PATCH 2/2] pull: improve default warning Felipe Contreras
2021-06-21 18:05 ` Alex Henrie
2021-06-21 18:51 ` Felipe Contreras
2021-06-21 21:47 ` Alex Henrie
2021-06-21 22:12 ` Felipe Contreras
2021-06-22 3:15 ` Alex Henrie
2021-06-22 4:26 ` Felipe Contreras
2021-06-22 15:06 ` Elijah Newren
2021-06-22 21:22 ` Alex Henrie
2021-06-23 2:20 ` Elijah Newren
2021-06-23 4:18 ` Felipe Contreras
2021-06-23 6:47 ` Elijah Newren
2021-06-23 17:24 ` Felipe Contreras
2021-06-23 1:09 ` Felipe Contreras
2021-06-23 7:54 ` Elijah Newren
2021-06-23 18:19 ` Felipe Contreras
2021-06-24 3:38 ` Alex Henrie
2021-06-24 5:55 ` Felipe Contreras
2021-06-27 0:17 ` Alex Henrie
2021-06-27 4:21 ` Felipe Contreras
2021-06-23 0:48 ` [PATCH v2 0/2] pull: documentation improvements Felipe Contreras
2021-06-23 0:48 ` [PATCH v2 1/2] doc: pull: explain what is a fast-forward Felipe Contreras
2021-06-23 0:48 ` [PATCH v2 2/2] pull: improve default warning Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210621175234.1079004-2-felipe.contreras@gmail.com \
--to=felipe.contreras@gmail.com \
--cc=alexhenrie24@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=jacob.keller@gmail.com \
--cc=newren@gmail.com \
--cc=peff@peff.net \
--cc=vondruch@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).