Skip to contentSkip to conversation

include/linux/mutex.h: unclear reference to convention

PATCH In review Matti Linnanvuori 2 participants 2 messages Sep 24, 2007

lore
Share & tools
lore
#0 lore raw

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

Randy Dunlap <[email protected]>:

Quoted 6 lines

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

#1 lore raw
Quoted 10 lines · Matti Linnanvuori

Randy Dunlap <[email protected]>:

Quoted 6 lines

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?

Signature · 2 lines
~Randy
Phaedrus says that Quality is about caring.