2007-09-24 07:38:54

by Matti Linnanvuori

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

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 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.





Machen Sie Yahoo! zu Ihrer Startseite. Los geht's:
http://de.yahoo.com/set


2007-09-24 16:47:43

by Randy Dunlap

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

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.
>>
>> 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.