Subject: Re: [PATCH] docuement filesystem helpers for custom 'struct file's
From: Dave Hansen <haveblue@us.ibm.com>
To: Randy Dunlap <randy.dunlap@oracle.com>
Cc: Christoph Hellwig <hch@infradead.org>, akpm@osdl.org,
       linux-kernel@vger.kernel.org
In-Reply-To: <20070919150724.4e64829a.randy.dunlap@oracle.com>
References: <20070917182718.70494C9B@kernel>
	 <20070917182718.A6B9F7FD@kernel> <20070919172611.GA20917@infradead.org>
	 <1190224043.26982.112.camel@localhost>
	 <20070919150724.4e64829a.randy.dunlap@oracle.com>
Content-Type: text/plain
Date: Thu, 20 Sep 2007 10:25:56 -0700
Message-Id: <1190309156.26982.144.camel@localhost>
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 952
Lines: 28

On Wed, 2007-09-19 at 15:07 -0700, Randy Dunlap wrote:
> 
> They aren't quite in kernel-doc format.  Holler if you need help
> with that, or see examples, or
> Documentation/kernel-doc-nano-HOWTO.txt.

Should we do comments for every single function argument, or is it OK to
leave them out for the obvious ones?

init_file() gets really boring:

> + * init_file - initialize a 'struct file'
> + * @file: the already allocated 'struct file' to initialized
> + * @mnt: the vfsmount on which the file resides
> + * @dentry: the dentry for the file
> + * @mode: the file's mode
> + * @fop: the file's operations

Seems like a waste of space to me, but I'd be happy to do them if that's
the convention.

-- Dave

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