Kernel Documentation Fantasy
Posted Dec 2, 2003 4:59 UTC (Tue) by iabervon
In reply to: Kernel Documentation Fantasy
Parent article: Review: Linux Kernel Development
Ah, but a section entitled Lock Ordering Rules, indexed under "locks" and
"rules", doesn't need to be part of the kernel source. In fact, it
probably would do better not to be interspersed with any code at all.
It's certainly something that's worth documenting (although the Linux
principal of lock ordering is, "if you have to document it, it's too
complicated"). For that matter, the ideal kernel document would contain
explanations of everything that isn't in the code, and why.
What the bit of TeX actually told me was why people use C instead of
Pascal in general (the Pascal standard omits most of the things necessary
for making a large project manageable).
Personally, I'd love to have a complete explanation of the kernel. But I
don't think that literate programming actually forms a clear presentation
of an explanation (nor does it help to clarify the code itself).
to post comments)