public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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
Subject: Re: [PATCH] docuement filesystem helpers for custom 'struct file's
Date: Thu, 20 Sep 2007 10:25:56 -0700	[thread overview]
Message-ID: <1190309156.26982.144.camel@localhost> (raw)
In-Reply-To: <20070919150724.4e64829a.randy.dunlap@oracle.com>

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


  reply	other threads:[~2007-09-20 17:26 UTC|newest]

Thread overview: 61+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-09-17 18:27 [PATCH 00/24] Read-only bind mounts Dave Hansen
2007-09-17 18:27 ` [PATCH 01/24] filesystem helpers for custom 'struct file's Dave Hansen
2007-09-19 17:26   ` Christoph Hellwig
2007-09-19 17:47     ` [PATCH] docuement " Dave Hansen
2007-09-19 22:07       ` Randy Dunlap
2007-09-20 17:25         ` Dave Hansen [this message]
2007-09-20 17:30           ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 02/24] rearrange may_open() to be r/o friendly Dave Hansen
2007-09-19 17:27   ` Christoph Hellwig
2007-09-20 18:47     ` Dave Hansen
2007-09-17 18:27 ` [PATCH 03/24] create cleanup helper svc_msnfs() Dave Hansen
2007-09-19 17:28   ` Christoph Hellwig
2007-09-19 17:39   ` Jan Engelhardt
2007-09-19 17:45     ` Dave Hansen
2007-09-19 17:54       ` Trond Myklebust
2007-09-19 17:59         ` Christoph Hellwig
2007-09-19 18:10           ` Trond Myklebust
2007-09-17 18:27 ` [PATCH 04/24] r/o bind mounts: stub functions Dave Hansen
2007-09-19 17:28   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 05/24] elevate write count open()'d files Dave Hansen
2007-09-19 17:30   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 06/24] r/o bind mounts: elevate write count for some ioctls Dave Hansen
2007-09-19 17:31   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 07/24] elevate writer count for chown and friends Dave Hansen
2007-09-19 17:31   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 08/24] make access() use mnt check Dave Hansen
2007-09-19 17:32   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 09/24] elevate mnt writers for callers of vfs_mkdir() Dave Hansen
2007-09-19 17:32   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 10/24] elevate write count during entire ncp_ioctl() Dave Hansen
2007-09-19 17:33   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 11/24] elevate write count for link and symlink calls Dave Hansen
2007-09-19 17:33   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 12/24] elevate mount count for extended attributes Dave Hansen
2007-09-19 17:34   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 13/24] elevate write count for file_update_time() Dave Hansen
2007-09-19 17:35   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 14/24] unix_find_other() elevate write count for touch_atime() Dave Hansen
2007-09-19 17:35   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 15/24] elevate write count over calls to vfs_rename() Dave Hansen
2007-09-19 17:35   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 16/24] nfs: check mnt instead of superblock directly Dave Hansen
2007-09-19 17:36   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 17/24] elevate writer count for do_sys_truncate() Dave Hansen
2007-09-19 17:36   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 18/24] elevate write count for do_utimes() Dave Hansen
2007-09-19 17:36   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 19/24] elevate write count for do_sys_utime() and touch_atime() Dave Hansen
2007-09-19 17:36   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 20/24] sys_mknodat(): elevate write count for vfs_mknod/create() Dave Hansen
2007-09-19 17:38   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 21/24] elevate mnt writers for vfs_unlink() callers Dave Hansen
2007-09-19 17:38   ` Christoph Hellwig
2007-09-17 18:27 ` [PATCH 22/24] do_rmdir(): elevate write count Dave Hansen
2007-09-19 17:39   ` Christoph Hellwig
2007-09-19 14:21 ` [PATCH 00/24] Read-only bind mounts Serge E. Hallyn
2007-09-19 17:44 ` Christoph Hellwig
2007-09-19 21:24   ` Andrew Morton
2007-09-19 21:56     ` Dave Hansen
2007-09-19 22:06       ` Andrew Morton
2007-09-20  9:58         ` Miklos Szeredi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1190309156.26982.144.camel@localhost \
    --to=haveblue@us.ibm.com \
    --cc=akpm@osdl.org \
    --cc=hch@infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=randy.dunlap@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox