git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Thomas Rast <trast@student.ethz.ch>, Petr Baudis <pasky@suse.cz>,
	Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 4/7] Documentation: merge: add an overview
Date: Sat, 23 Jan 2010 03:42:46 -0600	[thread overview]
Message-ID: <20100123094246.GE7571@progeny.tock> (raw)
In-Reply-To: <20100123092551.GA7571@progeny.tock>

The reader unfamiliar with the concepts of branching and merging
would have been completely lost.  Try to help him with a diagram.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
The advice in [1] was very helpful.  I fear I’ve made a mess of
the language even so.  At least it does seem much clearer now.

Thoughts?

[1] http://thread.gmane.org/gmane.comp.version-control.git/136356/focus=136629

 Documentation/git-merge.txt |   28 ++++++++++++++++++++++++++--
 1 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 83bf3e7..a7a40c6 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -15,8 +15,32 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-Merges the history specified by <commit> into HEAD, optionally using a
-specific merge strategy.
+Incorporates changes from the named commits (since the time their
+histories diverged from the current branch) into the current
+branch.  This command is used by 'git pull' to incorporate changes
+from another repository and can be used by hand to merge changes
+from one branch into another.
+
+Assume the following history exists and the current branch is
+"`master`":
+
+------------
+          A---B---C topic
+         /
+    D---E---F---G master
+------------
+
+Then "`git merge topic`" will replay the changes made on the
+`topic` branch since it diverged from `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.
+
+------------
+          A---B---C topic
+         /         \
+    D---E---F---G---H master
+------------
 
 The second syntax (<msg> `HEAD` <commit>...) is supported for
 historical reasons.  Do not use it from the command line or in
-- 
1.6.6

  parent reply	other threads:[~2010-01-23  9:43 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-01-23  9:25 [PATCH v2 0/7] clarify 'git merge' documentation Jonathan Nieder
2010-01-23  9:26 ` [PATCH 1/7] Documentation: merge: move configuration section to end Jonathan Nieder
2010-01-23  9:31 ` [PATCH 2/7] Documentation: suggest `reset --merge` in How Merge Works section Jonathan Nieder
2010-01-23  9:33 ` [PATCH 3/7] Documentation: merge: move merge strategy list to end Jonathan Nieder
2010-01-23  9:42 ` Jonathan Nieder [this message]
2010-02-12 14:15   ` [PATCH 4/7] Documentation: merge: add an overview Raja R Harinath
2010-01-23  9:44 ` [PATCH 5/7] Documentation: emphasize when git merge terminates early Jonathan Nieder
2010-01-23  9:45 ` [PATCH 6/7] Documentation: merge: add a section about fast-forward Jonathan Nieder
2010-01-23  9:48 ` [PATCH 7/7] Documentation: simplify How Merge Works Jonathan Nieder
2010-01-24 13:25 ` [PATCH v2 0/7] clarify 'git merge' documentation Thomas Rast
2010-01-24 19:29   ` Junio C Hamano

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20100123094246.GE7571@progeny.tock \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=pasky@suse.cz \
    --cc=trast@student.ethz.ch \
    /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.
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 NNTP newsgroup(s).