All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Thomas Rast <trast@student.ethz.ch>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH] Documentation: merge: use MERGE_HEAD to refer to the remote branch
Date: Sat, 23 Jan 2010 16:48:40 -0600	[thread overview]
Message-ID: <20100123224840.GA2136@progeny.tock> (raw)
In-Reply-To: <201001101324.47025.trast@student.ethz.ch>

commit 57bddb11 (Documentation/git-merge: reword references to
"remote" and "pull", 2010-01-07) fixed the manual to drop the
assumption that the other branch being merged is from a remote
repository.  Unfortunately, in a few places, to do so it
introduced the antecedentless phrase "their versions".  Worse, in
passages like the following, 'they' is playing two roles.

|   highlighting changes from both the HEAD and their versions.
|
| * Look at the diffs on their own. 'git log --merge -p <path>'

Using HEAD and MERGE_HEAD nicely assigns terminology to "our" and
"their" sides.  It also provides the reader with practice using
names that git will recognize on the command line.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
Thomas Rast wrote:
> Jonathan Nieder wrote:

>> Maybe:
>> 
>> |   * Look at the diffs.  'git diff' will show a three-way diff,
>> |     highlighting changes from both the HEAD and MERGE_HEAD
>> |     versions.
>
> I like this idea, as it nicely assigns terminology to the "their"
> side.  We need to explain MERGE_HEAD (it's not in the manpage yet),
> but that should fit in somewhere.

Here is a try.  This applies on top of the series to clarify 'git
merge' documentation [1] I sent earlier today, which conveniently
enough explains MERGE_HEAD a few sections earlier.

Thanks for the encouragement,
Jonathan

[1] http://thread.gmane.org/gmane.comp.version-control.git/137818

 Documentation/git-merge.txt |   14 ++++++++------
 1 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 7aa3f3f..4b1b2f5 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -215,15 +215,17 @@ You can work through the conflict with a number of tools:
    mergetool which will work you through the merge.
 
  * Look at the diffs.  `git diff` will show a three-way diff,
-   highlighting changes from both the HEAD and their versions.
+   highlighting changes from both the `HEAD` and `MERGE_HEAD`
+   versions.
 
- * Look at the diffs on their own. `git log --merge -p <path>`
-   will show diffs first for the HEAD version and then
-   their version.
+ * Look at the diffs from each branch. `git log --merge -p <path>`
+   will show diffs first for the `HEAD` version and then the
+   `MERGE_HEAD` version.
 
  * Look at the originals.  `git show :1:filename` shows the
-   common ancestor, `git show :2:filename` shows the HEAD
-   version and `git show :3:filename` shows their version.
+   common ancestor, `git show :2:filename` shows the `HEAD`
+   version, and `git show :3:filename` shows the `MERGE_HEAD`
+   version.
 
 
 EXAMPLES
-- 
1.6.6

  reply	other threads:[~2010-01-23 22:48 UTC|newest]

Thread overview: 46+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-01-07 17:03 [PATCH 1/2] Documentation/git-merge: reword references to "remote" and "pull" Thomas Rast
2010-01-07 17:03 ` [PATCH 2/2] Documentation: warn prominently against merging with dirty trees Thomas Rast
2010-01-07 17:03 ` [NON-PATCH 3/2] Documentation/git-merge: format full commands in typewriter font Thomas Rast
2010-01-07 20:25   ` Jonathan Nieder
2010-01-07 21:08   ` Junio C Hamano
2010-01-07 18:01 ` [PATCH 1/2] Documentation/git-merge: reword references to "remote" and "pull" Junio C Hamano
2010-01-10  0:02   ` [PATCH v2 0/4] Documentation style fixes Thomas Rast
2010-01-10  0:02     ` [PATCH v2 1/4] Documentation/git-merge: reword references to "remote" and "pull" Thomas Rast
2010-01-10  4:13       ` Jonathan Nieder
2010-01-10 12:24         ` Thomas Rast
2010-01-23 22:48           ` Jonathan Nieder [this message]
2010-01-10  0:02     ` [PATCH v2 2/4] Documentation: warn prominently against merging with dirty trees Thomas Rast
2010-01-10  4:49       ` Jonathan Nieder
2010-01-10  6:31         ` Junio C Hamano
2010-01-10 12:16           ` Thomas Rast
2010-01-11  2:13           ` Jonathan Nieder
2010-01-11  2:30             ` Junio C Hamano
2010-01-11  4:13               ` Jonathan Nieder
2010-01-11  8:21                 ` [PATCH 0/6] " Jonathan Nieder
2010-01-11  8:27                   ` [PATCH/RFC 1/6] Documentation: clarify one-line description for merge Jonathan Nieder
2010-01-11  8:30                   ` [PATCH 2/6] Documentation: merge: add an overview Jonathan Nieder
2010-01-11 10:09                     ` Junio C Hamano
2010-01-11  8:37                   ` [PATCH 4/6] Documentation: emphasize when git merge terminates early Jonathan Nieder
2010-01-11 23:11                     ` Thomas Rast
2010-01-11  8:39                   ` [PATCH 5/6] Documentation: merge: add a section about fast-forward Jonathan Nieder
2010-01-11  8:43                   ` [PATCH 6/6] Documentation: tweak How Merge Works Jonathan Nieder
2010-01-11 23:11                     ` Thomas Rast
2010-01-13 10:44                   ` [PATCH 0/6] Re: Documentation: warn prominently against merging with dirty trees Petr Baudis
2010-01-13  6:55                 ` [PATCH v2 2/4] " Junio C Hamano
2010-01-10  0:02     ` [PATCH v2 3/4] Documentation: format full commands in typewriter font Thomas Rast
2010-01-10  3:31       ` Jonathan Nieder
2010-01-10  0:07     ` [PATCH v2 0/4] Documentation style fixes Thomas Rast
2010-01-10  0:19       ` Thomas Rast
2010-01-10  6:34       ` Junio C Hamano
2010-01-10 12:10         ` Thomas Rast
2010-01-10 12:10           ` [PATCH 1/2] More missed dashed 'git-cmd' forms Thomas Rast
2010-01-10 12:10             ` [PATCH 2/2] More missed `code snippets` Thomas Rast
2010-01-10 12:11           ` [PATCH] Documentation: show-files is now called git-ls-files Thomas Rast
2010-01-18  1:18         ` [PATCH v2 0/4] Documentation style fixes Junio C Hamano
2010-01-19 17:29           ` Thomas Rast
2010-01-19 17:39             ` Jonathan Nieder
2010-01-10  7:12       ` Junio C Hamano
     [not found]     ` <9516c897017ec420403bb7f687fb8962de42cb7c.1263081032.git.trast@student.ethz.ch>
2010-01-10  2:56       ` [PATCH v2 4/4] Documentation: spell 'git cmd' without dash throughout Jonathan Nieder
2010-01-10  2:59         ` [PATCH 1/2] Documentation: git gc packs refs by default now Jonathan Nieder
2010-01-10  3:01         ` [PATCH 2/2] Documentation: tiny git config manual tweaks Jonathan Nieder
2010-01-10 12:21         ` [PATCH v2 4/4] Documentation: spell 'git cmd' without dash throughout Thomas Rast

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=20100123224840.GA2136@progeny.tock \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.