Commit b1e32126 authored by Christoph Hellwig's avatar Christoph Hellwig Committed by Jan Kara
Browse files

udf: kill useless file header comments for vfs method implementations 



There's not need to document vfs method invocation rules, we have
Documentation/filesystems/vfs.txt and Documentation/filesystems/Locking
for that.  Also a lot of these comments where either plain wrong or
horrible out of date.

Signed-off-by: default avatarChristoph Hellwig <hch@lst.de>
Signed-off-by: default avatarJan Kara <jack@suse.cz>
parent f1f73ba8

fs/udf/dir.c

+0 −26
Original line number Diff line number Diff line
@@ -188,32 +188,6 @@ static int do_udf_readdir(struct inode *dir, struct file *filp, 
	return 0;

}



/*

 * udf_readdir

 *

 * PURPOSE

 *	Read a directory entry.

 *

 * DESCRIPTION

 *	Optional - sys_getdents() will return -ENOTDIR if this routine is not

 *	available.

 *

 *	Refer to sys_getdents() in fs/readdir.c

 *	sys_getdents() -> .

 *

 * PRE-CONDITIONS

 *	filp			Pointer to directory file.

 *	buf			Pointer to directory entry buffer.

 *	filldir			Pointer to filldir function.

 *

 * POST-CONDITIONS

 *	<return>		>=0 on success.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */



static int udf_readdir(struct file *filp, void *dirent, filldir_t filldir)

{

	struct inode *dir = filp->f_path.dentry->d_inode;

fs/udf/file.c

+0 −46
Original line number Diff line number Diff line
@@ -144,40 +144,6 @@ static ssize_t udf_file_aio_write(struct kiocb *iocb, const struct iovec *iov, 
	return retval;

}



/*

 * udf_ioctl

 *

 * PURPOSE

 *	Issue an ioctl.

 *

 * DESCRIPTION

 *	Optional - sys_ioctl() will return -ENOTTY if this routine is not

 *	available, and the ioctl cannot be handled without filesystem help.

 *

 *	sys_ioctl() handles these ioctls that apply only to regular files:

 *		FIBMAP [requires udf_block_map()], FIGETBSZ, FIONREAD

 *	These ioctls are also handled by sys_ioctl():

 *		FIOCLEX, FIONCLEX, FIONBIO, FIOASYNC

 *	All other ioctls are passed to the filesystem.

 *

 *	Refer to sys_ioctl() in fs/ioctl.c

 *	sys_ioctl() -> .

 *

 * PRE-CONDITIONS

 *	inode			Pointer to inode that ioctl was issued on.

 *	filp			Pointer to file that ioctl was issued on.

 *	cmd			The ioctl command.

 *	arg			The ioctl argument [can be interpreted as a

 *				user-space pointer if desired].

 *

 * POST-CONDITIONS

 *	<return>		Success (>=0) or an error code (<=0) that

 *				sys_ioctl() will return.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */

int udf_ioctl(struct inode *inode, struct file *filp, unsigned int cmd,

	      unsigned long arg)

{
@@ -225,18 +191,6 @@ int udf_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, 
	return result;

}



/*

 * udf_release_file

 *

 * PURPOSE

 *  Called when all references to the file are closed

 *

 * DESCRIPTION

 *  Discard prealloced blocks

 *

 * HISTORY

 *

 */

static int udf_release_file(struct inode *inode, struct file *filp)

{

	if (filp->f_mode & FMODE_WRITE) {

fs/udf/inode.c

+1 −31
Original line number Diff line number Diff line
@@ -66,22 +66,7 @@ static void udf_update_extents(struct inode *, 
			       struct extent_position *);

static int udf_get_block(struct inode *, sector_t, struct buffer_head *, int);



/*

 * udf_delete_inode

 *

 * PURPOSE

 *	Clean-up before the specified inode is destroyed.

 *

 * DESCRIPTION

 *	This routine is called when the kernel destroys an inode structure

 *	ie. when iput() finds i_count == 0.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 *

 *  Called at the last iput() if i_nlink is zero.

 */



void udf_delete_inode(struct inode *inode)

{

	truncate_inode_pages(&inode->i_data, 0);
@@ -1416,21 +1401,6 @@ static mode_t udf_convert_permissions(struct fileEntry *fe) 
	return mode;

}



/*

 * udf_write_inode

 *

 * PURPOSE

 *	Write out the specified inode.

 *

 * DESCRIPTION

 *	This routine is called whenever an inode is synced.

 *	Currently this routine is just a placeholder.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */



int udf_write_inode(struct inode *inode, int sync)

{

	int ret;

fs/udf/namei.c

+0 −33
Original line number Diff line number Diff line
@@ -251,39 +251,6 @@ static struct fileIdentDesc *udf_find_entry(struct inode *dir, 
	return NULL;

}



/*

 * udf_lookup

 *

 * PURPOSE

 *	Look-up the inode for a given name.

 *

 * DESCRIPTION

 *	Required - lookup_dentry() will return -ENOTDIR if this routine is not

 *	available for a directory. The filesystem is useless if this routine is

 *	not available for at least the filesystem's root directory.

 *

 *	This routine is passed an incomplete dentry - it must be completed by

 *	calling d_add(dentry, inode). If the name does not exist, then the

 *	specified inode must be set to null. An error should only be returned

 *	when the lookup fails for a reason other than the name not existing.

 *	Note that the directory inode semaphore is held during the call.

 *

 *	Refer to lookup_dentry() in fs/namei.c

 *	lookup_dentry() -> lookup() -> real_lookup() -> .

 *

 * PRE-CONDITIONS

 *	dir			Pointer to inode of parent directory.

 *	dentry			Pointer to dentry to complete.

 *	nd			Pointer to lookup nameidata

 *

 * POST-CONDITIONS

 *	<return>		Zero on success.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */



static struct dentry *udf_lookup(struct inode *dir, struct dentry *dentry,

				 struct nameidata *nd)

{

fs/udf/super.c

+0 −42
Original line number Diff line number Diff line
@@ -1670,22 +1670,6 @@ static void udf_sb_free_bitmap(struct udf_bitmap *bitmap) 
		vfree(bitmap);

}



/*

 * udf_read_super

 *

 * PURPOSE

 *	Complete the specified super block.

 *

 * PRE-CONDITIONS

 *	sb			Pointer to superblock to complete - never NULL.

 *	sb->s_dev		Device to read suberblock from.

 *	options			Pointer to mount options.

 *	silent			Silent flag.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */

static int udf_fill_super(struct super_block *sb, void *options, int silent)

{

	int i;
@@ -1913,19 +1897,6 @@ void udf_warning(struct super_block *sb, const char *function, 
	       sb->s_id, function, error_buf);

}



/*

 * udf_put_super

 *

 * PURPOSE

 *	Prepare for destruction of the superblock.

 *

 * DESCRIPTION

 *	Called before the filesystem is unmounted.

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */

static void udf_put_super(struct super_block *sb)

{

	int i;
@@ -1961,19 +1932,6 @@ static void udf_put_super(struct super_block *sb) 
	sb->s_fs_info = NULL;

}



/*

 * udf_stat_fs

 *

 * PURPOSE

 *	Return info about the filesystem.

 *

 * DESCRIPTION

 *	Called by sys_statfs()

 *

 * HISTORY

 *	July 1, 1997 - Andrew E. Mileski

 *	Written, tested, and released.

 */

static int udf_statfs(struct dentry *dentry, struct kstatfs *buf)

{

	struct super_block *sb = dentry->d_sb;

CRA Git | Maintained and supported by SUSTech CRA and CCSE