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

From: Ingo Oeser (netdev_at_axxeo.de)
Date: 11/24/05

  • Next message: Thomas Gleixner: "[PATCH -mm] timespec: normalize off by one errors" 
    To: Jeff Garzik <jgarzik@pobox.com>
Date:	Thu, 24 Nov 2005 16:00:50 +0100

    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 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/

  • Next message: Thomas Gleixner: "[PATCH -mm] timespec: normalize off by one errors"

    Relevant Pages

    • Re: [RFC] [PATCH 1/3] ioat: DMA subsystem
      ... > Jeff Garzik wrote: ... > HOW and WHY should be obvious by the source code, ... send the line "unsubscribe linux-kernel" in ... Please read the FAQ at http://www.tux.org/lkml/ ...
      (Linux-Kernel)
    • Re: Possible GPL Violation of Linux in Amstrads E3 Videophone.
      ... > where I spell out the license requirements to Brian Eaton, ... > holder will query their apparent lack of compliance and Amstrad will be ... there's no source code or written offer in the box. ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)
    • Re: Insults in the kernel-sources
      ... >> So do and think about, because the you can find to much of insults in ... A warning should be put somewhere, ... explicit source code comments" maybe the source code should ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)
    • Re: Embedded Linux :: How different is it?
      ... I have seen linux run on a mobile phone. ... yes you absolutely are entitled to the full source code including ... send the line "unsubscribe linux-kernel" in ...
      (Linux-Kernel)
    • [PATCH] arch/x86_64/kernel/ptrace.c linux-2.6.14.4
      ... After looking at the process.c and ldt.c source code, ... routine in process.c, and the read_ldtroutine below is based off of ... didn't do that in this version of the patch. ... To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/ ...
      (Linux-Kernel)