Improving commit logs

[Glen Barber]

On Thu, Apr 14, 2016 at 01:14:46PM +0930, O'Connor, Daniel wrote:
> 
> > On 14 Apr 2016, at 13:13, Glen Barber <gjb at FreeBSD.org> wrote:
> > I absolutely agree with you that a guide on this will be beneficial.
> > Sorry if my reply was taken any other way.
> > 
> > If I had a genie in a bottle, my three wishes would be:
> > 
> > 1) Better commit messages that address the "what";
> > 2) Better explanation on the "why";
> 
> Huh interesting, I definitely would pick 2 before 1 but I can see
> what you mean for a lot of commits (especially to 30 year old cruft
> filled esoterica)
> 

When writing release notes, for example, the "what" is generally more
useful than the "why."  In other words, the end user does not generally
care *why* something changed, but they want to know *what* changed.

> > 3) More wishes.
> 
> You wish for more genies, wishing for more wishes is usually
> verboten.. ;)
> 

I also want a pony.  :)

Glen

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-hackers/attachments/20160414/590b57c1/attachment.sig>