17 Oct
2008
17 Oct
'08
10:39 p.m.
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