Re: [PATCH] docuement filesystem helpers for custom 'struct file's

view
thread

!MAILaRCHIVE_VOTE_RePLACE

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

[view in full thread]

From: Dave Hansen <haveblue@...>

To: Randy Dunlap <randy.dunlap@...>

Cc: Christoph Hellwig <hch@...>, <akpm@...>, <linux-kernel@...>

Subject: Re: [PATCH] docuement filesystem helpers for custom 'struct file's

Date: Thursday, September 20, 2007 - 1:25 pm

On Wed, 2007-09-19 at 15:07 -0700, Randy Dunlap wrote:
quoted text> 
> 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:

quoted text> + * 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

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

Previous message: [thread] [date] [author]
Next message: [thread] [date] [author]

Messages in current thread:

[PATCH 00/24] Read-only bind mounts, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 00/24] Read-only bind mounts, Christoph Hellwig, (Wed Sep 19, 1:44 pm)

Re: [PATCH 00/24] Read-only bind mounts, Andrew Morton, (Wed Sep 19, 5:24 pm)

Re: [PATCH 00/24] Read-only bind mounts, Dave Hansen, (Wed Sep 19, 5:56 pm)

Re: [PATCH 00/24] Read-only bind mounts, Andrew Morton, (Wed Sep 19, 6:06 pm)

Re: [PATCH 00/24] Read-only bind mounts, Miklos Szeredi, (Thu Sep 20, 5:58 am)

Re: [PATCH 00/24] Read-only bind mounts, Serge E. Hallyn, (Wed Sep 19, 10:21 am)

[PATCH 14/24] unix_find_other() elevate write count for touc..., Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 14/24] unix_find_other() elevate write count for ..., Christoph Hellwig, (Wed Sep 19, 1:35 pm)

[PATCH 22/24] do_rmdir(): elevate write count, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 22/24] do_rmdir(): elevate write count, Christoph Hellwig, (Wed Sep 19, 1:39 pm)

[PATCH 21/24] elevate mnt writers for vfs_unlink() callers, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 21/24] elevate mnt writers for vfs_unlink() callers, Christoph Hellwig, (Wed Sep 19, 1:38 pm)

[PATCH 19/24] elevate write count for do_sys_utime() and tou..., Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 19/24] elevate write count for do_sys_utime() and..., Christoph Hellwig, (Wed Sep 19, 1:36 pm)

[PATCH 20/24] sys_mknodat(): elevate write count for vfs_mkn..., Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 20/24] sys_mknodat(): elevate write count for vfs..., Christoph Hellwig, (Wed Sep 19, 1:38 pm)

[PATCH 09/24] elevate mnt writers for callers of vfs_mkdir(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 09/24] elevate mnt writers for callers of vfs_mkd..., Christoph Hellwig, (Wed Sep 19, 1:32 pm)

[PATCH 04/24] r/o bind mounts: stub functions, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 04/24] r/o bind mounts: stub functions, Christoph Hellwig, (Wed Sep 19, 1:28 pm)

[PATCH 11/24] elevate write count for link and symlink calls, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 11/24] elevate write count for link and symlink c..., Christoph Hellwig, (Wed Sep 19, 1:33 pm)

[PATCH 06/24] r/o bind mounts: elevate write count for some ..., Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 06/24] r/o bind mounts: elevate write count for s..., Christoph Hellwig, (Wed Sep 19, 1:31 pm)

[PATCH 18/24] elevate write count for do_utimes(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 18/24] elevate write count for do_utimes(), Christoph Hellwig, (Wed Sep 19, 1:36 pm)

[PATCH 16/24] nfs: check mnt instead of superblock directly, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 16/24] nfs: check mnt instead of superblock direc..., Christoph Hellwig, (Wed Sep 19, 1:36 pm)

[PATCH 17/24] elevate writer count for do_sys_truncate(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 17/24] elevate writer count for do_sys_truncate(), Christoph Hellwig, (Wed Sep 19, 1:36 pm)

[PATCH 15/24] elevate write count over calls to vfs_rename(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 15/24] elevate write count over calls to vfs_rena..., Christoph Hellwig, (Wed Sep 19, 1:35 pm)

[PATCH 12/24] elevate mount count for extended attributes, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 12/24] elevate mount count for extended attributes, Christoph Hellwig, (Wed Sep 19, 1:34 pm)

[PATCH 10/24] elevate write count during entire ncp_ioctl(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 10/24] elevate write count during entire ncp_ioct..., Christoph Hellwig, (Wed Sep 19, 1:33 pm)

[PATCH 01/24] filesystem helpers for custom 'struct file's, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 01/24] filesystem helpers for custom 'struct file's, Christoph Hellwig, (Wed Sep 19, 1:26 pm)

[PATCH] docuement filesystem helpers for custom 'struct file's, Dave Hansen, (Wed Sep 19, 1:47 pm)

Re: [PATCH] docuement filesystem helpers for custom 'struct ..., Randy Dunlap, (Wed Sep 19, 6:07 pm)

Re: [PATCH] docuement filesystem helpers for custom 'struct ..., Dave Hansen, (Thu Sep 20, 1:25 pm)

Re: [PATCH] docuement filesystem helpers for custom 'struct ..., Christoph Hellwig, (Thu Sep 20, 1:30 pm)

[PATCH 05/24] elevate write count open()'d files, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 05/24] elevate write count open()'d files, Christoph Hellwig, (Wed Sep 19, 1:30 pm)

[PATCH 07/24] elevate writer count for chown and friends, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 07/24] elevate writer count for chown and friends, Christoph Hellwig, (Wed Sep 19, 1:31 pm)

[PATCH 13/24] elevate write count for file_update_time(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 13/24] elevate write count for file_update_time(), Christoph Hellwig, (Wed Sep 19, 1:35 pm)

[PATCH 08/24] make access() use mnt check, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 08/24] make access() use mnt check, Christoph Hellwig, (Wed Sep 19, 1:32 pm)

[PATCH 03/24] create cleanup helper svc_msnfs(), Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Jan Engelhardt, (Wed Sep 19, 1:39 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Dave Hansen, (Wed Sep 19, 1:45 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Trond Myklebust, (Wed Sep 19, 1:54 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Christoph Hellwig, (Wed Sep 19, 1:59 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Trond Myklebust, (Wed Sep 19, 2:10 pm)

Re: [PATCH 03/24] create cleanup helper svc_msnfs(), Christoph Hellwig, (Wed Sep 19, 1:28 pm)

[PATCH 02/24] rearrange may_open() to be r/o friendly, Dave Hansen, (Mon Sep 17, 2:27 pm)

Re: [PATCH 02/24] rearrange may_open() to be r/o friendly, Christoph Hellwig, (Wed Sep 19, 1:27 pm)

Re: [PATCH 02/24] rearrange may_open() to be r/o friendly, Dave Hansen, (Thu Sep 20, 2:47 pm)

Navigation

Popular discussions


linux-kernel:
Greg Kroah-Hartman	[PATCH 002/196] Chinese: rephrase English introduction in HOWTO
Tarkan Erimer	Re: Dual-Licensing Linux Kernel with GPL V2 and GPL V3
Andrew Morton	Re: -mm merge plans for 2.6.23 -- sys_fallocate
Greg KH	Re: [AppArmor 39/45] AppArmor: Profile loading and manipulation, pathname matching
git:

linux-netdev:
Gerrit Renker	[PATCH 03/37] dccp: List management for new feature negotiation
Arjan van de Ven	Re: [GIT]: Networking
Jarek Poplawski	Re: [PATCH] pkt_sched: Destroy gen estimators under rtnl_lock().
Jarek Poplawski	Re: [BUG] New Kernel Bugs
openbsd-misc:

Colocation donated by:

Online users

Syndicate