Subject: Re: CVS commit: src/doc
To: Jun-ichiro itojun Hagino <itojun@itojun.org>
From: Alistair Crooks <agc@pkgsrc.org>
List: source-changes
Date: 12/12/2003 22:43:48
On Sat, Dec 13, 2003 at 07:27:02AM +0900, Jun-ichiro itojun Hagino wrote:
> >    
> >    Log Message:
> >    cvs
> > 
> > 
> > what does "cvs" mean?
> > 
> > 
> > can you please be a little less terse in your commit messages?
> > they are almost useless.
> 
> 	it is a documentation commit.  all the details are in the document
> 	itself.  i don't think it worthwhile/useful to repeat the same stuff
> 	in commit message as well as the documentation content.
> 	cvs diff is your friend.

I'm sorry, but I don't think that's sufficient.  It should not be
necessary to have to use cvs diff to find out what changed - because,
even then, that will only give me an idea of the differences at the
lowest level.  What the log should show is a high-level overview of
the changes that were made.

To neglect to give a summary of the changes made is to force everyone
to do much more work, when it would have been simpler to have outlined
the changes in the commit message in the first place.  I know I've
been guilty of this myself in the past, where I've been terse in
commit messages myself, only to find myself thinking, 6 months later,
"now why did I do that?".

Regards,
Alistair