Date: Thu, 4 Dec 2008 00:10:32 +0000
From: Alan Cox <alan@lxorguk.ukuu.org.uk>
To: Andrew Morton <akpm@linux-foundation.org>
Cc: Randy Dunlap <randy.dunlap@oracle.com>, rusty@rustcorp.com.au,
       rmk+lkml@arm.linux.org.uk, linux-kernel@vger.kernel.org,
       sfr@canb.auug.org.au
Subject: Re: Yet more ARM breakage in linux-next
Message-ID: <20081204001032.39d2a281@lxorguk.ukuu.org.uk>
In-Reply-To: <20081203154629.bba4e5e4.akpm@linux-foundation.org>
References: <20081203192905.GA12502@flint.arm.linux.org.uk>
	<20081203124109.79f8f15b.akpm@linux-foundation.org>
	<200812040952.44957.rusty@rustcorp.com.au>
	<49371848.2080804@oracle.com>
	<20081203154629.bba4e5e4.akpm@linux-foundation.org>
Organization: Red Hat UK Cyf., Amberley Place, 107-111 Peascod Street,
 Windsor, Berkshire, SL4 1TE, Y Deyrnas Gyfunol. Cofrestrwyd yng Nghymru a
 Lloegr o'r rhif cofrestru 3798903
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 755
Lines: 16

> For some reason, the act of typing in some kerneldoc makes people's
> brains turn off.  Perhaps it's because "oh, I am supposed to type some
> documentation here" instead of "gee, I think this code is unclear,
> let's clarify that".

Well prior to the kerneldoc stuff they didn't type anything at all to
clarify or document. Also kerneldoc is meant for documenting the APIs not
so much the internals of functions. When used sensibly it can be very
useful, especially if it documents API locking rules.

Alan
--
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/