From owner-cvs-all Wed Nov 28 3: 6:22 2001 Delivered-To: cvs-all@freebsd.org Received: from peter3.wemm.org (c1315225-a.plstn1.sfba.home.com [24.14.150.180]) by hub.freebsd.org (Postfix) with ESMTP id 9DCD937B419; Wed, 28 Nov 2001 03:06:13 -0800 (PST) Received: from overcee.netplex.com.au (overcee.wemm.org [10.0.0.3]) by peter3.wemm.org (8.11.0/8.11.0) with ESMTP id fASB6DM80580; Wed, 28 Nov 2001 03:06:13 -0800 (PST) (envelope-from peter@wemm.org) Received: from wemm.org (localhost [127.0.0.1]) by overcee.netplex.com.au (Postfix) with ESMTP id 5E3073808; Wed, 28 Nov 2001 03:06:13 -0800 (PST) (envelope-from peter@wemm.org) X-Mailer: exmh version 2.5 07/13/2001 with nmh-1.0.4 To: Mike Barcroft Cc: Maxim Sobolev , des@FreeBSD.org, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: Meaningless commit messages [was: cvs commit: ports/www/linux-opera Makefile] In-Reply-To: <20011127163513.A12400@espresso.q9media.com> Date: Wed, 28 Nov 2001 03:06:13 -0800 From: Peter Wemm Message-Id: <20011128110613.5E3073808@overcee.netplex.com.au> 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 Mike Barcroft wrote: > Maxim Sobolev writes: > > On Tue, 27 Nov 2001 09:49:16 -0800 (PST), Dag-Erling Smorgrav wrote: > > > des 2001/11/27 09:49:16 PST > > > > > > Modified files: > > > www/linux-opera Makefile > > > Log: > > > Pander to the backseat drivers. > > > > Could you please use more meaningful commit messages? For > > example it is absolutely impossible to guess what this > > commit is all about without looking at the diff. > > >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." Well, the guide is over simplifying it. Also, dont forget the previous paragraph: Good commit messages are important. They tell others why you did the changes you did, not just right here and now, but months or years from now when someone wonders why some seemingly illogical or inefficient piece of code snuck into your source file. It is also an invaluable aid to deciding which changes to MFC and which not to MFC. I was planning to change the paragraph that you quoted to something like this: Commit messages should be clear, concise and provide a reasonable summary to give an indication of what was changed and why. Commit messages should provide enough information to enable a third party to decide if the change is relevant to them and if they need to read the change itself. Cheers, -Peter -- Peter Wemm - peter@FreeBSD.org; peter@yahoo-inc.com; peter@netplex.com.au "All of this is for nothing if we don't go to the stars" - JMS/B5 To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message