Re: [RFC] [PATCH 1/3] ioat: DMA subsystem

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.


Regards

Ingo Oeser

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to [email protected]
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

---

• Follow-Ups:
  • Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
    • From: Jeff Garzik <[email protected]>

• References:
  • [RFC] [PATCH 1/3] ioat: DMA subsystem
    • From: Andrew Grover <[email protected]>
  • Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
    • From: Jeff Garzik <[email protected]>

• Prev by Date: [PATCH -mm] timespec: normalize off by one errors
• Next by Date: Re: [patch -rt] add EXPORT_PER_CPU_LOCKED_SYMBOL to asm-x86_64/percpu.h
• Previous by thread: Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
• Next by thread: Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
• Index(es):
  • Date
  • Thread

[Index of Archives]     [Kernel Newbies]     [Netfilter]     [Bugtraq]     [Photo]     [Stuff]     [Gimp]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Video 4 Linux]     [Linux for the blind]     [Linux Resources]