From owner-cvs-all Wed Nov 28 16:18:21 2001 Delivered-To: cvs-all@freebsd.org Received: from monorchid.lemis.com (monorchid.lemis.com [192.109.197.75]) by hub.freebsd.org (Postfix) with ESMTP id BE31437B417; Wed, 28 Nov 2001 16:18:12 -0800 (PST) Received: by monorchid.lemis.com (Postfix, from userid 1004) id BE67278566; Thu, 29 Nov 2001 10:48:10 +1030 (CST) Date: Thu, 29 Nov 2001 10:48:10 +1030 From: Greg Lehey To: Giorgos Keramidas Cc: Robert Watson , Mike Barcroft , cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG Subject: Re: Committer's guide policy on commit message contents Message-ID: <20011129104810.A74413@monorchid.lemis.com> References: <20011127163513.A12400@espresso.q9media.com> <20011128014533.GA14146@hades.hell.gr> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20011128014533.GA14146@hades.hell.gr> User-Agent: Mutt/1.3.23i Organization: The FreeBSD Project Phone: +61-8-8388-8286 Fax: +61-8-8388-8725 Mobile: +61-418-838-708 WWW-Home-Page: http://www.FreeBSD.org/ X-PGP-Fingerprint: 6B 7B C3 8C 61 CD 54 AF 13 24 52 F8 6D A4 95 EF Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG On Wednesday, 28 November 2001 at 3:45:33 +0200, Giorgos Keramidas wrote: > 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. FWIW, this is the kind of change which shouldn't happen. "rationalise" is a perfectly valid spelling. Just because the Americans prefer "rationalize" is not a reason to change it, any more than there would be a reason for an Australian to change it back again. Greg -- See complete headers for address and phone numbers To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message