On Wed, Jul 31, 2002 at 03:16:05PM +0100, Sam Vilain wrote:
> the exception of the O(1) scheduler, very nice). At the very least, I
> think every function should have a comment listing all of its input
> variables and what they mean, along with a rough idea of what the
> function does, and what it returns, along with any assumptions.
I would like to see at least the identifiers named sanely
(is there already in the Linux kernel) and ALL the assumptions
documented with BUG_ON() or sth. like this.
The rest can be reconstructed by reading the source. But non-local
assumptions are a nasty source for BUGs :-(
> It would make the code a *lot* easier for programmers with less
> than guru levels of knowledge to understand and hack on.
But it shouldn't be that easy, that Aunt Tillie starts submitting
feature patches without understanding the whole picture ;-)
PS: Trimmed CC a little, since these people are busy doing other
things.
Regards
Ingo Oeser
-- Science is what we can tell a computer. Art is everything else. --- D.E.Knuth - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
This archive was generated by hypermail 2b29 : Wed Aug 07 2002 - 22:00:21 EST