Date: Tue, 27 Nov 2001 22:26:26 -0000 From: Paul Richards <paul@freebsd-services.com> To: Robert Watson <rwatson@FreeBSD.org>, Mike Barcroft <mike@FreeBSD.org> Cc: cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: Committer's guide policy on commit message contents Message-ID: <383590000.1006899985@lobster.originative.co.uk> In-Reply-To: <Pine.NEB.3.96L.1011127163632.20120A-100000@fledge.watson.org> References: <Pine.NEB.3.96L.1011127163632.20120A-100000@fledge.watson.org>
next in thread | previous in thread | raw e-mail | index | archive | help
--On Tuesday, November 27, 2001 16:37:49 -0500 Robert Watson <rwatson@FreeBSD.org> 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? I've always interpreted that to mean, don't say things like "put an uderscore in front of variables", since that's self evident from the diff, instead explain why you saw the need to add the underscores and what problems have been solved in doing so. I think we agree on the general intent but the wording perhaps isn't as good as it needs to be. Paul Richards FreeBSD Services Ltd http://www.freebsd-services.com 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?383590000.1006899985>