Date: Wed, 28 Nov 2001 03:45:33 +0200 From: Giorgos Keramidas <charon@labs.gr> To: Robert Watson <rwatson@FreeBSD.ORG> Cc: Mike Barcroft <mike@FreeBSD.ORG>, cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG Subject: Re: Committer's guide policy on commit message contents Message-ID: <20011128014533.GA14146@hades.hell.gr> In-Reply-To: <Pine.NEB.3.96L.1011127163632.20120A-100000@fledge.watson.org> References: <20011127163513.A12400@espresso.q9media.com> <Pine.NEB.3.96L.1011127163632.20120A-100000@fledge.watson.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On 2001-11-27 16:37:49, Robert Watson wrote: > > On Tue, 27 Nov 2001, Mike Barcroft wrote: > > > From the Committers Guide: "Do not waste space in the commit messages > > explaining what you did. That is what cvs diff is for. Instead, tell > > us why you did it." > > Ignoring, for a moment, any context -- I think this is actually not a good > policy. In the event that there are complex or large changes being made, > a brief summary of the changes, along with the rationale, is appropriate > in the commit message. At least, that's my feeling :-). Is this > something that would be worth changing? Well, yes and no. I did learn a lot for -doc style from browsing the logs in cvsweb a couple of years back. Changelogs like: Fix typo. are OK, but changes like: Fix typo: "rationalise" -> "rationalize". are VERY nicer. I think it's useful to have a 'short description' of what changes together with why it changes. It's just up to the committer's judgement to avoid duplicating the entire code/documentation changes in the commit log (since `cvs diff' is easy to use). -giorgos To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20011128014533.GA14146>