From: Sergey Organov <sorganov@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 4/6] Documentation/git-merge.txt: improve short description in NAME
Date: Thu, 06 Oct 2016 00:01:59 +0300 [thread overview]
Message-ID: <87a8eiqzlk.fsf@javad.com> (raw)
In-Reply-To: <xmqqa8eiptt2.fsf@gitster.mtv.corp.google.com> (Junio C. Hamano's message of "Wed, 05 Oct 2016 10:52:25 -0700")
Junio C Hamano <gitster@pobox.com> writes:
> sorganov@gmail.com writes:
>
>> From: Sergey Organov <sorganov@gmail.com>
>>
>> Old description not only raised the question of why the tool is called
>> git-merge rather than git-join, but "join histories" also sounds like
>> very simple operation, something like what "git-merge -s ours" does.
>>
>> Signed-off-by: Sergey Organov <sorganov@gmail.com>
>> ---
>> Documentation/git-merge.txt | 3 ++-
>> 1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
>> index 216d2f4..cc0329d 100644
>> --- a/Documentation/git-merge.txt
>> +++ b/Documentation/git-merge.txt
>> @@ -3,7 +3,8 @@ git-merge(1)
>>
>> NAME
>> ----
>> -git-merge - Join two or more development histories together
>> +
>> +git-merge - Merge one or more branches to the current branch
>
> This patch, evaluated by itself, looks like a regression in that it
> tries to explain "merge" by using verb "merge", making it fuzzier to
> those who do not yet know what a "merge" is. That was why it tried
> to explain "merge" as an operation to join histories.
My thought was that "merge", the operation, is so well-known term that
it could well go into the NAME section without explanation.
Besides:
$ man merge
NAME
merge - three-way file merge
[...]
Uses the same pattern.
>
> However, the next one, 5/6, resurrects the "join history" in the
> description part to help them, so the damage is not so severe when
> we take them together.
Damage? In SCM world we can track the issue back to:
$ man -k rcsmerge
rcsmerge (1) - merge RCS revisions
-- Sergey
next prev parent reply other threads:[~2016-10-05 21:02 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-05 14:46 [PATCH 0/6] git-merge: a few documentation improvements sorganov
2016-10-05 14:46 ` [PATCH 1/6] git-merge: clarify "usage" by adding "-m <msg>" sorganov
2016-10-05 17:46 ` Junio C Hamano
2016-10-05 20:41 ` Sergey Organov
2016-10-05 14:46 ` [PATCH 2/6] Documentation/git-merge.txt: remove list of options from SYNOPSIS sorganov
2016-10-05 17:47 ` Junio C Hamano
2016-10-05 21:03 ` Sergey Organov
2016-10-05 14:46 ` [PATCH 3/6] Documentation/git-merge.txt: fix SYNOPSIS of obsolete form to include options sorganov
2016-10-05 14:46 ` [PATCH 4/6] Documentation/git-merge.txt: improve short description in NAME sorganov
2016-10-05 17:52 ` Junio C Hamano
2016-10-05 21:01 ` Sergey Organov [this message]
2016-10-05 17:55 ` Jeff King
2016-10-05 20:44 ` Sergey Organov
2016-10-05 14:46 ` [PATCH 5/6] Documentation/git-merge.txt: improve short description in DESCRIPTION sorganov
2016-10-05 16:58 ` Jakub Narębski
2016-10-05 20:01 ` Junio C Hamano
2016-10-05 21:27 ` Sergey Organov
2016-10-06 13:21 ` Sergey Organov
2016-10-05 18:07 ` Junio C Hamano
2016-10-05 21:24 ` Sergey Organov
2016-10-05 21:41 ` Junio C Hamano
2016-10-06 12:30 ` Sergey Organov
2016-10-06 17:46 ` Junio C Hamano
2016-10-07 13:13 ` Sergey Organov
2016-10-05 14:46 ` [PATCH 6/6] Documentation/git-merge.txt: get rid of irrelevant references to git-pull sorganov
2016-10-05 18:57 ` Junio C Hamano
2016-10-05 21:34 ` Sergey Organov
2016-10-05 21:43 ` Junio C Hamano
2016-10-06 12:39 ` Sergey Organov
2016-10-06 18:06 ` Junio C Hamano
2016-10-07 11:45 ` Sergey Organov
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=87a8eiqzlk.fsf@javad.com \
--to=sorganov@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.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).