[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Commit header lines (was: git history tracking across renames (and e

From: Paul Eggert
Subject: Re: Commit header lines (was: git history tracking across renames (and emacs support))
Date: Sat, 14 Jul 2018 16:57:12 -0500
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1

On 07/14/2018 11:23 AM, Eli Zaretskii wrote:
If a summary line is a shorter version of the main text, that's a good
thing. It's like a good title for a news article or a research paper: it
restates the main text briefly, and there is real value in that.
I disagree with your perception, but I guess we are getting into the
gray area where personal preferences mean more than anything else.

I suppose it could be called a personal preference, in that I prefer to follow the common practice of summarizing the commit message in its first line. This standard for Git, where the summary line is commonly used to good effect. We old-timers know about predecessor version-control systems like RCS and CVS where other commit-message conventions might have made sense too. But those days are gone, and good riddance if you ask me.

Today the primary use of a summary line is to give readers a quick way to see whether a change is worth looking into in more detail, and authors of patches should keep this in mind.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]