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

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

From
Sergey Organov <sorganov@gmail.com>
Date
Oct 6, 2016, 12:30 UTC
Message-ID
<87mvihpsla.fsf@javad.com>
In-Reply-To
<xmqqa8eio4n9.fsf@gitster.mtv.corp.google.com>
Junio C Hamano <gitster@pobox.com> writes:
Show 24 quoted lines
> Sergey Organov <sorganov@gmail.com> writes:
>
>> OK, I see. So, what is the best way to handle this? Immediately follow
>> content change patch with another patch that only re-flows?
>
> Or no reflowing at all.
>
>>> the parents".  I do not know if the updated phrasing is better.  The
>>> "name" in the original was meant to be a short-hand for "object name",
>>> and I would support a change to spell it out to clarify; "reference"
>>> can be a vague word that can mean different things in Git, and when
>>> the word is given without context, most Git people would think that
>>> the word refers to "refs", but that is definitely not what the new
>>> commit records, so...
>>
>> I won't insist on the change, but "name" sounded wrong to me, and
>> "reference" was most general term I was able to come up with in this
>> context.
>> ...
>> Last, if "reference" is not good enough and we get to internals anyway,
>> why not say SHA1 then?
>
> Because that is still colloquial? I think s/name/object name/ is a
> sensible change, but not s/name/reference/.

No, "reference" is more sensible here than any of "name", "object name", or "SHA-1", the same way as here:

$ git help glossary
[...]
chain
        A list of objects, where each object in the list contains a
        reference to its successor (for example, the successor of a
        commit could be one of its parents).
[...]
$

The resulting merge commit is an origin for 2 chains, so it stores 2 references to its successors. No need to be aware of any [object] names to understand all this.

-- Sergey
Previous: Junio C HamanoNext: Junio C Hamano
Message 14 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.