Re: [PATCH 21/35] Unionfs: Inode operations

[Andrew Morton]

On Tue, 5 Dec 2006 22:27:10 +0100 (MET)
Jan Engelhardt <jengelh@xxxxxxxxxxxxxxx> wrote:

> 
> On Dec 4 2006 07:30, Josef 'Jeff' Sipek wrote:
> >+	if (!hidden_dentry) {
> >+		/* if hidden_dentry is NULL, create the entire
> >+		 * dentry directory structure in branch 'bindex'.
> >+		 * hidden_dentry will NOT be null when bindex == bstart
> >+		 * because lookup passed as a negative unionfs dentry
> >+		 * pointing to a lone negative underlying dentry */
> >+		hidden_dentry = create_parents(parent, dentry, bindex);
> 
> 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).

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.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/