Re: [PATCH] include/linux/mutex.h: unclear reference to convention

From: Randy Dunlap
Date: Mon Sep 24 2007 - 12:47:44 EST


Matti Linnanvuori wrote:
Randy Dunlap <randy.dunlap@xxxxxxxxxx>:
Another convention is that we put kernel-doc with the implementation
(i.e., in .c files) when possible, not with the function prototype.
Of course, for inline functions or macros in header files, that's
where the kernel-doc has to live.

so we don't need this patch.

You should not expect that every reader of the kernel files is aware of that convention. I was not and therefore I sought referenced files for some time.

Sure, I agree with you.
Where should we put this information so that people will find it?

--
~Randy
Phaedrus says that Quality is about caring.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/