Re: [Linuxwacom-devel] [PATCH] - very minor fixes

[Peter H. <pet...@wh...>]

On Wed, Nov 25, 2009 at 08:34:41PM +0000, Przemysław Firszt wrote:
> Dnia 2009-11-25, śro o godzinie 10:39 +1000, Peter Hutterer pisze:
> > Przemo - please use the git commit messages as a tool to convey the reason
> > behind the patch (not necessarily the method, it's often obvious).
> > git commits are cheap, git log is cheap and I find myself reading log files
> > more often than the actual code they change. With hundreds of commits and
> > several repositories to keep track of, it becomes quite important to be able
> > to find commits and _understand_ commits quickly. as a general rule, if you
> > were to just send the patch, the commit message should convey enough
> > information why one should review and apply the patch - without even looking
> > at the source.
> > 
> > commit messages like "comment fixed" have little meaning in that regard. In
> > this case something more explanatory is 
> > "Fix comment - xf86WcmInitalprivSize is actually xf86WcmInitialToolSize"
> > or, for the other patch
> > "Remove duplicate comment for xf86WcmRegisterX11Devices.
> > 
> > This function still exists, a duplicate comment got accidentally added in
> > 425351f22821ade814f7f6412d18c1eb25904661."
> > 
> Peter,
> I really appreciate your comments and I'll stick to those rules next
> time. Do you really want me to add hash No. to commit messages? ;-) (I
> just learnt how to use "git blame")

if it makes sense for a particular message - yes please. it's not needed
that often though so just use common sense.

fwiw, I recommend checking out 'tig' as well, it's great for navigating git
logs and has a vastly superior git blame interface.

Cheers,
  Peter