git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 4/6] Documentation/git-merge.txt: improve short description in NAME

From
Sergey Organov <sorganov@gmail.com>
Date
Oct 5, 2016, 20:44 UTC
Message-ID
<87fuoar0eb.fsf@javad.com>
In-Reply-To
<20161005175512.aruzndaow3g2jmt7@sigill.intra.peff.net>
Jeff King <peff@peff.net> writes:
Show 28 quoted lines
> 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.
Previous: Jeff King
Message 31 of 31 in “git-merge: a few documentation improvements”
  1. 0/6 git-merge: a few documentation improvementssorganov@gmail.com, Oct 5, 2016
  2. 2/6 Documentation/git-merge.txt: remove list of options from SYNOPSISsorganov@gmail.com, Oct 5, 2016
  3. Junio C HamanoOct 5, 2016
  4. Sergey OrganovOct 5, 2016
  5. 3/6 Documentation/git-merge.txt: fix SYNOPSIS of obsolete form to include optionssorganov@gmail.com, Oct 5, 2016
  6. 5/6 Documentation/git-merge.txt: improve short description in DESCRIPTIONsorganov@gmail.com, Oct 5, 2016
  7. Jakub NarębskiOct 5, 2016
  8. Junio C HamanoOct 5, 2016
  9. Sergey OrganovOct 5, 2016
  10. Sergey OrganovOct 6, 2016
  11. Junio C HamanoOct 5, 2016
  12. Sergey OrganovOct 5, 2016
  13. Junio C HamanoOct 5, 2016
  14. Sergey OrganovOct 6, 2016
  15. Junio C HamanoOct 6, 2016
  16. Sergey OrganovOct 7, 2016
  17. 1/6 git-merge: clarify "usage" by adding "-m <msg>"sorganov@gmail.com, Oct 5, 2016
  18. Junio C HamanoOct 5, 2016
  19. Sergey OrganovOct 5, 2016
  20. 6/6 Documentation/git-merge.txt: get rid of irrelevant references to git-pullsorganov@gmail.com, Oct 5, 2016
  21. Junio C HamanoOct 5, 2016
  22. Sergey OrganovOct 5, 2016
  23. Junio C HamanoOct 5, 2016
  24. Sergey OrganovOct 6, 2016
  25. Junio C HamanoOct 6, 2016
  26. Sergey OrganovOct 7, 2016
  27. 4/6 Documentation/git-merge.txt: improve short description in NAMEsorganov@gmail.com, Oct 5, 2016
  28. Junio C HamanoOct 5, 2016
  29. Sergey OrganovOct 5, 2016
  30. Jeff KingOct 5, 2016
  31. Sergey OrganovOct 5, 2016

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.