Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id ; Wed, 31 Jul 2002 10:12:58 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id ; Wed, 31 Jul 2002 10:12:58 -0400 Received: from noc.easyspace.net ([62.254.202.67]:22278 "EHLO noc.easyspace.net") by vger.kernel.org with ESMTP id ; Wed, 31 Jul 2002 10:12:57 -0400 Date: Wed, 31 Jul 2002 15:16:05 +0100 From: Sam Vilain To: Rik van Riel Cc: davidsen@tmr.com, jamagallon@able.es, andrea@suse.de, alan@lxorguk.ukuu.org.uk, habanero@us.ibm.com, linux-kernel@vger.kernel.org, marcelo@conectiva.com.br Subject: Re: Linux 2.4.19-rc3 (hyperthreading) In-Reply-To: References: X-Mailer: Sylpheed version 0.7.8claws (GTK+ 1.2.10; i386-debian-linux-gnu) X-Face: NErb*2NY4\th?$s.!!]_9le_WtWE'b4;dk<5ot)OW2hErS|tE6~D3errlO^fVil?{qe4Lp_m\&Ja!;>%JqlMPd27X|;b!GH'O.,NhF*)e\ln4W}kFL5c`5t'9,(~Bm_&on,0Ze"D>rFJ$Y[U""nR Sender: linux-kernel-owner@vger.kernel.org X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 1475 Lines: 34 Rik van Riel wrote: > Having code this readable is pretty much essential for > maintenance, too. > I wouldn't mind if every time I code or patch something > that isn't up to the reading standard of Mr. Magallon's > code somebody would raise his hand and/or LART me, until > the code is easily readable. The GNU coding standards make some very sensible comments on this subject. A very good read; http://www.gnu.org/prep/standards_24.html I find it interesting that a large quantity of the kernel and C library source code I have come across recently has no comments (with the exception of the O(1) scheduler, very nice). At the very least, I think every function should have a comment listing all of its input variables and what they mean, along with a rough idea of what the function does, and what it returns, along with any assumptions. It would make the code a *lot* easier for programmers with less than guru levels of knowledge to understand and hack on. -- Sam Vilain, sam@vilain.net WWW: http://sam.vilain.net/ 7D74 2A09 B2D3 C30F F78E GPG: http://sam.vilain.net/sam.asc 278A A425 30A9 05B5 2F13 Its not the size of the ship, its the size of the waves. LITTLE RICHARD - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/