From owner-cvs-all Tue Nov 27 14:14: 8 2001 Delivered-To: cvs-all@freebsd.org Received: from mail11.speakeasy.net (mail11.speakeasy.net [216.254.0.211]) by hub.freebsd.org (Postfix) with ESMTP id 063F337B405 for ; Tue, 27 Nov 2001 14:13:56 -0800 (PST) Received: (qmail 29823 invoked from network); 27 Nov 2001 22:14:23 -0000 Received: from unknown (HELO laptop.baldwin.cx) ([64.81.54.73]) (envelope-sender ) by mail11.speakeasy.net (qmail-ldap-1.03) with SMTP for ; 27 Nov 2001 22:14:23 -0000 Message-ID: X-Mailer: XFMail 1.4.0 on FreeBSD X-Priority: 3 (Normal) Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 8bit MIME-Version: 1.0 In-Reply-To: <20011127214156.D32325@tao.org.uk> Date: Tue, 27 Nov 2001 14:13:52 -0800 (PST) From: John Baldwin To: Josef Karthauser Subject: Re: Meaningless commit messages [was: cvs commit: ports/www/linu Cc: cvs-all@FreeBSD.org, cvs-committers@FreeBSD.org, des@FreeBSD.org, Maxim Sobolev , Mike Barcroft 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 27-Nov-01 Josef Karthauser wrote: > On Tue, Nov 27, 2001 at 04:35:13PM -0500, 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." >> > > The "what" is important too, the "how" can be read from the patch, but > the "what" may not be obvious. Saying why you did something also doesn't provide a means for people to have their interests piqued by a change so that they go review it after the fact. It's nice to be able to read cvs log on a file to see what has happened to teh file in its history. Often times when leaping back through histories by following a line via cvs annotate, I like being able to just read the log message to understand the change than having to read every single diff. Log messages are useful not just the one time they appear in the mailing list, but in the future when people come back to examine it later on, possibly after the original committer has moved on. Verbose log messages are good as they don't go away. > Joe -- John Baldwin <>< http://www.FreeBSD.org/~jhb/ "Power Users Use the Power to Serve!" - http://www.FreeBSD.org/ To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message