CVS commit messages

Christian Robottom Reis kiko at async.com.br
Mon Jan 19 18:34:13 UTC 2004


On Fri, Jan 16, 2004 at 06:28:01PM -0500, David Miller wrote:
> A checkin comment should contain a *short* description of what the patch
> does.  NOT the summary of the bug, unless that bug summary happens to
> describe that adequately.
> 
> Bad example: (sorry for singling this one out, it's not the only offender
> lately, but it's an example of this)

Sorry boss, won't happen [*] again.

[*] This is specially painful since I normally describe *what* the
change did along with the bug summary (honest!). I don't think that
including the bug summary is a bad thing (it helps a quick-scan of a
checkin list, for instance), but I agree that the essential bit is a
summary of the changes themselves. I was in a hurry this Friday -- I was
worried I wouldn't make the 2.17.7 cut so I guess I just forgot this
one time.

Take care,
--
Christian Robottom Reis | http://async.com.br/~kiko/ | [+55 16] 261 2331



More information about the developers mailing list