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

Re: commit summary, --pretty=short and other tools

From
Benoit SIGOURE <tsuna@lrde.epita.fr>
Date
Sep 17, 2007, 23:52 UTC
Message-ID
<55887C88-8523-4839-8B91-236256A5E893@lrde.epita.fr>
In-Reply-To
<20070917112136.GA30201@glandium.org>
On Sep 17, 2007, at 1:21 PM, Mike Hommey wrote:
Show 13 quoted lines
> Hi,
>
> I kind of shot myself in the foot with how to type proper commit
> messages.
>
> The git-commit manual page reads:
>   Though not required, it´s a good idea to begin the commit message  
> with a
>   single short (less than 50 character) line summarizing the change,
>   followed by a blank line and then a more thorough description.
>
> ... and I happen to not have done the "followed by a blank line" part.
>
[...]
> What do you think ?

I started using Git as a "better SVN client" and didn't follow this "good idea". The thing, as I already pointed out on IRC, these a are more rules than just guidelines. Some tools (such as rebase) enforce them. That is, they rewrite commit messages. I found this extremely annoying (Junio provided a patch but I don't know whether it's been applied, I personally use it in my Git).

See this thread: http://marc.info/?t=118561729500001&r=1&w=2

My opinion is that it would be better to keep the first line and never ever rewrite the commit messages.

Cheers,
-- 
Benoit Sigoure aka Tsuna
EPITA Research and Development Laboratory
Previous: Jeff KingNext: Junio C Hamano
Message 3 of 10 in “commit summary, --pretty=short and other tools”
  1. Mike HommeySep 17, 2007
  2. Jeff KingSep 17, 2007
  3. Benoit SIGOURESep 17, 2007
  4. Junio C HamanoSep 18, 2007
  5. Andreas EricssonSep 18, 2007
  6. Johannes SchindelinSep 18, 2007
  7. Andreas EricssonSep 18, 2007
  8. Benoit SIGOURESep 18, 2007
  9. Johannes SchindelinSep 18, 2007
  10. Wincent ColaiutaSep 18, 2007

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.