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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Mon, 24 Sep 2007 07:49:36 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Matti Linnanvuori <mattilinnanvuori@...oo.com>
CC:	Andrew Morton <akpm@...ux-foundation.org>,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] include/linux/mutex.h: unclear reference to convention

Matti Linnanvuori wrote:
> Randy Dunlap <randy.dunlap@...cle.com>:
>> 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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/