git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sergey Organov <sorganov@gmail.com>
To: Jeff King <peff@peff.net>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: Re: [PATCH 4/6] Documentation/git-merge.txt: improve short description in NAME
Date: Wed, 05 Oct 2016 23:44:44 +0300	[thread overview]
Message-ID: <87fuoar0eb.fsf@javad.com> (raw)
In-Reply-To: <20161005175512.aruzndaow3g2jmt7@sigill.intra.peff.net> (Jeff King's message of "Wed, 5 Oct 2016 13:55:13 -0400")

Jeff King <peff@peff.net> writes:

> On Wed, Oct 05, 2016 at 05:46:22PM +0300, sorganov@gmail.com wrote:
>
>> 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
>
> I wonder if we should be more clear that you don't have to merge a
> branch; you can merge any commit. I do agree that the original was
> unnecessarily general. And I think "the current branch" is accurate
> (technically it can be to a detached HEAD, but that is pedantry that
> doesn't need to make it into the synopsis).
>
> So maybe "Merge one or more commits into the current branch".  I guess
> that is a bit vague, too. It is really "commit tips" or "lines of
> development" that we are merging. Bringing them in of course brings in
> many commits, but the "or more" there is meant to hint at multi-parent
> merges.
>
> So perhaps "one or more branches", while not completely accurate, is the
> best we can do. I dunno.

You've basically repeated my entire line of thinking that lead to the
patch.

-- Sergey.

  reply	other threads:[~2016-10-05 20:54 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
2016-10-05 17:55   ` Jeff King
2016-10-05 20:44     ` Sergey Organov [this message]
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

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

  git send-email \
    --in-reply-to=87fuoar0eb.fsf@javad.com \
    --to=sorganov@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    /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).