On Thu 27 Apr, Zach Welch wrote:
> Argh, I really didn't want to get involved in this type of debate
> (wholly opinionated and unresolvable to anyone's complete
> satisfaction), but I honestly believe that the quality of the comments
> could be improved markedly from where they currently are. This stems
> directly from the fact that I (an experienced programmer who was
> already fairly well familiar with ARM) would _really_ have appreciated
> better comments having been there, and that I'd like to see future
> programmers get off easier.
OK. Now I haven't touched the kernel code yet, so I can't say one way or
the other what I think of the current level of commenting, but Zach's
comments suggest that there is a need for something to make it easier to
'get up to speed' on relevant issues.
Given that we do not really have agreement here on what should go in the
source itself, perhaps a separate document describing the ARM-specific
parts of the kernel and relevant resources is the way to go?
I have started bringing together info, and writing stuff up to make what
should become 'ARMlinux: the book' in the medium term. (In the short term
these docs are going on the web). One chapter of this should certainly be
on overview of the kernel: source structure, design decisions etc. This
could do the job of filling the gotchas that Zach describes, I hope.
What I don't have is the knowledge to write this. Would any of you kernel
people like to contribute an outline that I can edit into proper docs? I
suspect there are only a few people here with the relevant knowledge...
Even just suggestions of what should be in would be a start, and I'll
endeavour to discover said info from those who know :-) Once this is done
I think we would not have too much trouble keeping it updated as things
change (athough, of course such a document, (as with all documents) will
be somewhat behind the state-of-the-art).
Good idea? Bad idea? comments welcome.
It occurs to me that perhaps this discussion should be on arm-kernel, but
we've started here now...
Wookey
--
Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK Tel (00 44) 1223 811679
work: http://www.aleph1.co.uk/ play: http://www.chaos.org.uk/~wookey/
unsubscribe: body of `unsubscribe linux-arm' to [EMAIL PROTECTED]
++ Please use [EMAIL PROTECTED] for ++
++ kernel-related discussions. ++
