public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Timur Tabi <timur@freescale.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH 2/2][for v2008.10] 85xx: Using proper I2C source clock divider for MPC8544
Date: Fri, 17 Oct 2008 15:39:27 -0500	[thread overview]
Message-ID: <48F8F7FF.1040502@freescale.com> (raw)
In-Reply-To: <940DD369-F390-4CCB-8748-78B7492CC17D@kernel.crashing.org>

Kumar Gala wrote:

>> How about adding a comment that the RM is wrong?   Any time the code
>> disagrees with the RM, it *has* to be documented.
> 
> Its documented in the commit.

Sorry, but that's just not good enough for me.  I *hate* it when people say that
it is.

When I'm looking at some code, and I don't understand what it does, the last
thing I'm doing to do is scour through the git log trying to find some
explanation.

Would it really have been so hard to add this line?

/* The MPC8544 RM says it's bit 26, but it's really bit 28 */

Why don't we take your reasoning to the next level, and just say that code
comments are unnecessary because the git log contains everything we need to know?

-- 
Timur Tabi
Linux kernel developer at Freescale

  reply	other threads:[~2008-10-17 20:39 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-10-17  2:58 [U-Boot] [PATCH 1/2][for v2008.10] Revert "85xx: Using proper I2C source clock divider for MPC8544" Kumar Gala
2008-10-17  2:58 ` [U-Boot] [PATCH 2/2][for v2008.10] 85xx: Using proper I2C source clock divider for MPC8544 Kumar Gala
2008-10-17  8:52   ` Wolfgang Denk
2008-10-17  9:55   ` Wolfgang Grandegger
2008-10-17 18:54   ` Timur Tabi
2008-10-17 20:35     ` Kumar Gala
2008-10-17 20:39       ` Timur Tabi [this message]
2008-10-20 13:02         ` Jerry Van Baren
2008-10-20 19:22           ` Wolfgang Denk
2008-10-20 20:06             ` Kumar Gala
2008-10-17  8:51 ` [U-Boot] [PATCH 1/2][for v2008.10] Revert "85xx: Using proper I2C source clock divider for MPC8544" Wolfgang Denk

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=48F8F7FF.1040502@freescale.com \
    --to=timur@freescale.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox