Message-ID: <46F7CE80.4070805@oracle.com>
Date: Mon, 24 Sep 2007 07:49:36 -0700
From: Randy Dunlap <randy.dunlap@oracle.com>
User-Agent: Thunderbird 1.5.0.5 (X11/20060719)
MIME-Version: 1.0
To: Matti Linnanvuori <mattilinnanvuori@yahoo.com>
CC: Andrew Morton <akpm@linux-foundation.org>, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] include/linux/mutex.h: unclear reference to convention
References: <377076.1597.qm@web52004.mail.re2.yahoo.com>
In-Reply-To: <377076.1597.qm@web52004.mail.re2.yahoo.com>
Content-Type: text/plain; charset=iso-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 908
Lines: 24

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