Messages in this thread | | | Date | Thu, 24 Nov 2005 10:04:33 -0500 | From | Jeff Garzik <> | Subject | Re: [RFC] [PATCH 1/3] ioat: DMA subsystem |
| |
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
- 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/
| |