From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner+willy=40w.ods.org-S1751364AbVKXPEl@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1751364AbVKXPEl (ORCPT <rfc822;willy@w.ods.org>);
	Thu, 24 Nov 2005 10:04:41 -0500
Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1751365AbVKXPEk
	(ORCPT <rfc822;linux-kernel-outgoing>);
	Thu, 24 Nov 2005 10:04:40 -0500
Received: from havoc.gtf.org ([69.61.125.42]:7859 "EHLO havoc.gtf.org")
	by vger.kernel.org with ESMTP id S1751364AbVKXPEj (ORCPT
	<rfc822;linux-kernel@vger.kernel.org>);
	Thu, 24 Nov 2005 10:04:39 -0500
Date: Thu, 24 Nov 2005 10:04:33 -0500
From: Jeff Garzik <jgarzik@pobox.com>
To: Ingo Oeser <netdev@axxeo.de>
Cc: Andrew Grover <andrew.grover@intel.com>, netdev@vger.kernel.org,
       linux-kernel@vger.kernel.org, john.ronciak@intel.com,
       christopher.leech@intel.com
Subject: Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
Message-ID: <20051124150433.GA3590@havoc.gtf.org>
References: <Pine.LNX.4.44.0511231207410.32487-100000@isotope.jf.intel.com> <4384F0C4.1090209@pobox.com> <200511241600.50046.netdev@axxeo.de>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <200511241600.50046.netdev@axxeo.de>
User-Agent: Mutt/1.4.1i
Sender: linux-kernel-owner@vger.kernel.org
X-Mailing-List: linux-kernel@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