From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jeff Garzik Subject: Re: [RFC] [PATCH 1/3] ioat: DMA subsystem Date: Thu, 24 Nov 2005 10:04:33 -0500 Message-ID: <20051124150433.GA3590@havoc.gtf.org> References: <4384F0C4.1090209@pobox.com> <200511241600.50046.netdev@axxeo.de> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: Andrew Grover , netdev@vger.kernel.org, linux-kernel@vger.kernel.org, john.ronciak@intel.com, christopher.leech@intel.com Return-path: To: Ingo Oeser Content-Disposition: inline In-Reply-To: <200511241600.50046.netdev@axxeo.de> Sender: linux-kernel-owner@vger.kernel.org List-Id: netdev.vger.kernel.org On Thu, Nov 24, 2005 at 04:00:50PM +0100, Ingo Oeser wrote: > Hi, > > Jeff Garzik wrote: > > explanation of this function would be nice. remember to answer "how?" > > and "why?", not "what?". > > Wasn't it the other way around? > Citing linux/Documentation/CodingStyle, section 7 "Comments": > > "Generally, you want your comments to tell WHAT your code does, not HOW." > > HOW and WHY should be obvious by the source code, unless > the sources are a mess. Yes, good point, thanks for the correction. Jeff