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

2007-09-25 Thread Randy Dunlap
On Tue, 25 Sep 2007 01:11:05 -0700 (PDT) Matti Linnanvuori wrote: > If you want to maintain the convention of documenting the interface only in > .c files, > you should write the convention in so many places in .h files that no one > could overlook it. > But I think the convention is bad and it

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

2007-09-25 Thread Matti Linnanvuori
If you want to maintain the convention of documenting the interface only in .c files, you should write the convention in so many places in .h files that no one could overlook it. But I think the convention is bad and it would be better to document the interface also in .h files where it is defi

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

2007-09-24 Thread Randy Dunlap
Matti Linnanvuori wrote: Randy Dunlap <[EMAIL PROTECTED]>: 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.

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

2007-09-24 Thread Matti Linnanvuori
Randy Dunlap <[EMAIL PROTECTED]>: > 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

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

2007-09-22 Thread Randy Dunlap
On Sat, 22 Sep 2007 01:41:17 -0700 (PDT) Matti Linnanvuori wrote: > From: Matti Linnanvuori <[EMAIL PROTECTED]> > > Reference to two different conventions is unnecessarily unclear unless you > know them already and requires seeking and reading another file for > understanding. Could you hit t

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

2007-09-22 Thread Matti Linnanvuori
From: Matti Linnanvuori <[EMAIL PROTECTED]> Reference to two different conventions is unnecessarily unclear unless you know them already and requires seeking and reading another file for understanding. Signed-off-by: Matti Linnanvuori <[EMAIL PROTECTED]> --- --- linux-2.6.23-rc7/include/linux/m