just to make things clear ... I thought the code isn't that bad commented. I may be wrong, of course. but could you have a look at few routines
(ext3_ext_create_new_leaf() or ext3_ext_get_blocks() fo example)
and tell me what's wrong with existing comments (besides monkey english)
and how it should look like?
thanks, Alex
>>>>> Andrew Morton (AM) writes:
AM> On Thu, 10 Aug 2006 13:29:56 +0400
AM> Alex Tomas <[email protected]> wrote:
AM> - The code is very poorly commented. I'd want to spend a lot of time
AM> reviewing this implementation, but not in its present state.
>>
>> what sort of comments are you expecting?
AM> Ones which tell me what the code is attempting to do. Ones which tell me
AM> the things which I need to know and which I cannot determine from the
AM> implementation within a reasonable period of time. Ones which tell me
AM> about the hidden design decisions, the known shortcomings, the
AM> things-still-to-do.
AM> It's a bit of an artform, really. I guess one needs to put oneself in the
AM> position of the reader, then work out what the reader wants to know.
AM> Good examples don't immediately leap to mind, I'm afraid. Maybe some of
AM> fs/buffer.c? That's important and pretty tricky code in there, so it goes
AM> to some lengths.
-
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/
[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]
