Date: Tue, 5 Dec 2006 20:12:41 -0800
From: Randy Dunlap <randy.dunlap@oracle.com>
To: Andrew Morton <akpm@osdl.org>
Cc: Jan Engelhardt <jengelh@linux01.gwdg.de>,
       "Josef 'Jeff' Sipek" <jsipek@cs.sunysb.edu>,
       linux-kernel@vger.kernel.org, torvalds@osdl.org, hch@infradead.org,
       viro@ftp.linux.org.uk, linux-fsdevel@vger.kernel.org,
       mhalcrow@us.ibm.com
Subject: Re: [PATCH 21/35] Unionfs: Inode operations
Message-Id: <20061205201241.55c1dd9f.randy.dunlap@oracle.com>
In-Reply-To: <20061205135017.3be94142.akpm@osdl.org>
References: <1165235468365-git-send-email-jsipek@cs.sunysb.edu>
	<11652354711835-git-send-email-jsipek@cs.sunysb.edu>
	<Pine.LNX.4.61.0612052222190.18570@yvahk01.tjqt.qr>
	<20061205135017.3be94142.akpm@osdl.org>
Organization: Oracle Linux Eng.
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1650
Lines: 55

On Tue, 5 Dec 2006 13:50:17 -0800 Andrew Morton wrote:

> On Tue, 5 Dec 2006 22:27:10 +0100 (MET)
> Jan Engelhardt <jengelh@linux01.gwdg.de> wrote:
> 
> > Someone refresh me: what's the correct[preferred] kdoc style?
> 
> This isn't part of kernel-doc, if that's what you mean.
> 
> > (A)
> > 	/* Lorem ipsum dolor sit amet, consectetur
> > 	 * adipisicing elit, sed do eiusmod tempor
> > 	 * incididunt ut labore et dolore magna aliqua. */
> > 
> > (B)
> > 	/* Lorem ipsum dolor sit amet, consectetur
> > 	   adipisicing elit, sed do eiusmod tempor
> > 	   incididunt ut labore et dolore magna aliqua. */
> > 
> > (C)
> > 	/* Lorem ipsum dolor sit amet, consectetur
> > 	adipisicing elit, sed do eiusmod tempor incididunt
> > 	ut labore et dolore magna aliqua. */
> 
> You forgot (D), (E), (F), (G) and a whole lot more besides.
> 
> It doesn't matter a lot what we do, but we should do it one way and not 38
> ways.
> 
> Documentation/CodingStyle doesn't mention commenting at all (eyes roll
> heavenwards).

I have several (probably 5-6) Doc/CodingStyle changes in my WIP
(work-in-progress) folder that I will do in the next few days.


> This
> 
> 	/*
> 	 * Lorem ipsum dolor sit amet, consectetur
> 	 * adipisicing elit, sed do eiusmod tempor
> 	 * incididunt ut labore et dolore magna aliqua.
> 	 */
> 
> is probably the most common, and is what I use when forced to descrog
> comments.

---
~Randy
-
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/