From owner-cvs-all Tue Nov 27 17:45:55 2001 Delivered-To: cvs-all@freebsd.org Received: from mailsrv.otenet.gr (mailsrv.otenet.gr [195.170.0.5]) by hub.freebsd.org (Postfix) with ESMTP id 11DAE37B41A; Tue, 27 Nov 2001 17:45:38 -0800 (PST) Received: from hades.hell.gr (patr530-a127.otenet.gr [212.205.215.127]) by mailsrv.otenet.gr (8.11.5/8.11.5) with ESMTP id fAS1jX827984; Wed, 28 Nov 2001 03:45:33 +0200 (EET) Received: (from charon@localhost) by hades.hell.gr (8.11.6/8.11.6) id fAS1jXr14191; Wed, 28 Nov 2001 03:45:33 +0200 (EET) (envelope-from charon@labs.gr) Date: Wed, 28 Nov 2001 03:45:33 +0200 From: Giorgos Keramidas To: Robert Watson Cc: Mike Barcroft , 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> References: <20011127163513.A12400@espresso.q9media.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.3.23.1i 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 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