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

Re: [PATCH] Documentation: Use 'First Paragraph' instead of 'First Line'.

From
Junio C Hamano <gitster@pobox.com>
Date
Sep 13, 2012, 21:15 UTC
Message-ID
<7vwqzx62vv.fsf@alter.siamese.dyndns.org>
In-Reply-To
<505248C3.7000803@codeweavers.com>
Jeremy White <jwhite@codeweavers.com> writes:
Show 21 quoted lines
> Thanks for the feedback; new patch inbound.  Minor nits:
>
>>> diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
>>> index f7815e9..92f97e6 100644
>>> --- a/Documentation/gitcore-tutorial.txt
>>> +++ b/Documentation/gitcore-tutorial.txt
>>> @@ -956,7 +956,7 @@ $ git show-branch --topo-order --more=1 master mybranch
>>>  ------------------------------------------------
>>>  
>>>  The first two lines indicate that it is showing the two branches
>>> -and the first line of the commit log message from their
>>> +and the first paragraph of the commit log message from their
>>>  top-of-the-tree commits, you are currently on `master` branch
>>>  (notice the asterisk `\*` character), and the first column for
>>>  the later output lines is used to show commits contained in the
>> 
>> Ditto.
>
> I did not substantially alter this. The emphasis of this section
> is on the broader show-branch output, and belaboring the subject would
> be distracting and unnecessary imho.

Yeah, but if that is the focus of this part of the documentation, wouldn't a patch to update "the first line" with something more generic like "title of the commit" be more appropriate?

Previous: Jeremy WhiteNext: Jeremy White
Message 4 of 8 in “Documentation: Use 'First Paragraph' instead of 'First Line'.”
  1. Documentation: Use 'First Paragraph' instead of 'First Line'.Jeremy White, Sep 13, 2012
  2. Junio C HamanoSep 13, 2012
  3. Jeremy WhiteSep 13, 2012
  4. Junio C HamanoSep 13, 2012
  5. Jeremy WhiteSep 13, 2012
  6. Junio C HamanoSep 13, 2012
  7. Jeremy WhiteSep 13, 2012
  8. Philip OakleySep 13, 2012

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.