diff options
author | Christoph Hellwig <hch@lst.de> | 2008-02-22 06:38:48 -0500 |
---|---|---|
committer | Jan Kara <jack@suse.cz> | 2008-04-17 08:22:23 -0400 |
commit | b1e321266d8797b21eac433b11458ac65b098938 (patch) | |
tree | 6943fc804fe03baa73ae925fb99010acedf02ed0 | |
parent | f1f73ba8e9b0eb97f90c6256b94afeb035d97562 (diff) |
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: Christoph Hellwig <hch@lst.de>
Signed-off-by: Jan Kara <jack@suse.cz>
-rw-r--r-- | fs/udf/dir.c | 26 | ||||
-rw-r--r-- | fs/udf/file.c | 46 | ||||
-rw-r--r-- | fs/udf/inode.c | 32 | ||||
-rw-r--r-- | fs/udf/namei.c | 33 | ||||
-rw-r--r-- | fs/udf/super.c | 42 |
5 files changed, 1 insertions, 178 deletions
diff --git a/fs/udf/dir.c b/fs/udf/dir.c index 8d8643ada199..31feef916fb7 100644 --- a/fs/udf/dir.c +++ b/fs/udf/dir.c | |||
@@ -188,32 +188,6 @@ static int do_udf_readdir(struct inode *dir, struct file *filp, | |||
188 | return 0; | 188 | return 0; |
189 | } | 189 | } |
190 | 190 | ||
191 | /* | ||
192 | * udf_readdir | ||
193 | * | ||
194 | * PURPOSE | ||
195 | * Read a directory entry. | ||
196 | * | ||
197 | * DESCRIPTION | ||
198 | * Optional - sys_getdents() will return -ENOTDIR if this routine is not | ||
199 | * available. | ||
200 | * | ||
201 | * Refer to sys_getdents() in fs/readdir.c | ||
202 | * sys_getdents() -> . | ||
203 | * | ||
204 | * PRE-CONDITIONS | ||
205 | * filp Pointer to directory file. | ||
206 | * buf Pointer to directory entry buffer. | ||
207 | * filldir Pointer to filldir function. | ||
208 | * | ||
209 | * POST-CONDITIONS | ||
210 | * <return> >=0 on success. | ||
211 | * | ||
212 | * HISTORY | ||
213 | * July 1, 1997 - Andrew E. Mileski | ||
214 | * Written, tested, and released. | ||
215 | */ | ||
216 | |||
217 | static int udf_readdir(struct file *filp, void *dirent, filldir_t filldir) | 191 | static int udf_readdir(struct file *filp, void *dirent, filldir_t filldir) |
218 | { | 192 | { |
219 | struct inode *dir = filp->f_path.dentry->d_inode; | 193 | struct inode *dir = filp->f_path.dentry->d_inode; |
diff --git a/fs/udf/file.c b/fs/udf/file.c index 97c71ae7c689..822cc4071527 100644 --- a/fs/udf/file.c +++ b/fs/udf/file.c | |||
@@ -144,40 +144,6 @@ static ssize_t udf_file_aio_write(struct kiocb *iocb, const struct iovec *iov, | |||
144 | return retval; | 144 | return retval; |
145 | } | 145 | } |
146 | 146 | ||
147 | /* | ||
148 | * udf_ioctl | ||
149 | * | ||
150 | * PURPOSE | ||
151 | * Issue an ioctl. | ||
152 | * | ||
153 | * DESCRIPTION | ||
154 | * Optional - sys_ioctl() will return -ENOTTY if this routine is not | ||
155 | * available, and the ioctl cannot be handled without filesystem help. | ||
156 | * | ||
157 | * sys_ioctl() handles these ioctls that apply only to regular files: | ||
158 | * FIBMAP [requires udf_block_map()], FIGETBSZ, FIONREAD | ||
159 | * These ioctls are also handled by sys_ioctl(): | ||
160 | * FIOCLEX, FIONCLEX, FIONBIO, FIOASYNC | ||
161 | * All other ioctls are passed to the filesystem. | ||
162 | * | ||
163 | * Refer to sys_ioctl() in fs/ioctl.c | ||
164 | * sys_ioctl() -> . | ||
165 | * | ||
166 | * PRE-CONDITIONS | ||
167 | * inode Pointer to inode that ioctl was issued on. | ||
168 | * filp Pointer to file that ioctl was issued on. | ||
169 | * cmd The ioctl command. | ||
170 | * arg The ioctl argument [can be interpreted as a | ||
171 | * user-space pointer if desired]. | ||
172 | * | ||
173 | * POST-CONDITIONS | ||
174 | * <return> Success (>=0) or an error code (<=0) that | ||
175 | * sys_ioctl() will return. | ||
176 | * | ||
177 | * HISTORY | ||
178 | * July 1, 1997 - Andrew E. Mileski | ||
179 | * Written, tested, and released. | ||
180 | */ | ||
181 | int udf_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, | 147 | int udf_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, |
182 | unsigned long arg) | 148 | unsigned long arg) |
183 | { | 149 | { |
@@ -225,18 +191,6 @@ int udf_ioctl(struct inode *inode, struct file *filp, unsigned int cmd, | |||
225 | return result; | 191 | return result; |
226 | } | 192 | } |
227 | 193 | ||
228 | /* | ||
229 | * udf_release_file | ||
230 | * | ||
231 | * PURPOSE | ||
232 | * Called when all references to the file are closed | ||
233 | * | ||
234 | * DESCRIPTION | ||
235 | * Discard prealloced blocks | ||
236 | * | ||
237 | * HISTORY | ||
238 | * | ||
239 | */ | ||
240 | static int udf_release_file(struct inode *inode, struct file *filp) | 194 | static int udf_release_file(struct inode *inode, struct file *filp) |
241 | { | 195 | { |
242 | if (filp->f_mode & FMODE_WRITE) { | 196 | if (filp->f_mode & FMODE_WRITE) { |
diff --git a/fs/udf/inode.c b/fs/udf/inode.c index 24cfa55d0fdc..dc2f946dfca9 100644 --- a/fs/udf/inode.c +++ b/fs/udf/inode.c | |||
@@ -66,22 +66,7 @@ static void udf_update_extents(struct inode *, | |||
66 | struct extent_position *); | 66 | struct extent_position *); |
67 | static int udf_get_block(struct inode *, sector_t, struct buffer_head *, int); | 67 | static int udf_get_block(struct inode *, sector_t, struct buffer_head *, int); |
68 | 68 | ||
69 | /* | 69 | |
70 | * udf_delete_inode | ||
71 | * | ||
72 | * PURPOSE | ||
73 | * Clean-up before the specified inode is destroyed. | ||
74 | * | ||
75 | * DESCRIPTION | ||
76 | * This routine is called when the kernel destroys an inode structure | ||
77 | * ie. when iput() finds i_count == 0. | ||
78 | * | ||
79 | * HISTORY | ||
80 | * July 1, 1997 - Andrew E. Mileski | ||
81 | * Written, tested, and released. | ||
82 | * | ||
83 | * Called at the last iput() if i_nlink is zero. | ||
84 | */ | ||
85 | void udf_delete_inode(struct inode *inode) | 70 | void udf_delete_inode(struct inode *inode) |
86 | { | 71 | { |
87 | truncate_inode_pages(&inode->i_data, 0); | 72 | truncate_inode_pages(&inode->i_data, 0); |
@@ -1416,21 +1401,6 @@ static mode_t udf_convert_permissions(struct fileEntry *fe) | |||
1416 | return mode; | 1401 | return mode; |
1417 | } | 1402 | } |
1418 | 1403 | ||
1419 | /* | ||
1420 | * udf_write_inode | ||
1421 | * | ||
1422 | * PURPOSE | ||
1423 | * Write out the specified inode. | ||
1424 | * | ||
1425 | * DESCRIPTION | ||
1426 | * This routine is called whenever an inode is synced. | ||
1427 | * Currently this routine is just a placeholder. | ||
1428 | * | ||
1429 | * HISTORY | ||
1430 | * July 1, 1997 - Andrew E. Mileski | ||
1431 | * Written, tested, and released. | ||
1432 | */ | ||
1433 | |||
1434 | int udf_write_inode(struct inode *inode, int sync) | 1404 | int udf_write_inode(struct inode *inode, int sync) |
1435 | { | 1405 | { |
1436 | int ret; | 1406 | int ret; |
diff --git a/fs/udf/namei.c b/fs/udf/namei.c index 112a5fb0b27b..ac7f72779e93 100644 --- a/fs/udf/namei.c +++ b/fs/udf/namei.c | |||
@@ -251,39 +251,6 @@ static struct fileIdentDesc *udf_find_entry(struct inode *dir, | |||
251 | return NULL; | 251 | return NULL; |
252 | } | 252 | } |
253 | 253 | ||
254 | /* | ||
255 | * udf_lookup | ||
256 | * | ||
257 | * PURPOSE | ||
258 | * Look-up the inode for a given name. | ||
259 | * | ||
260 | * DESCRIPTION | ||
261 | * Required - lookup_dentry() will return -ENOTDIR if this routine is not | ||
262 | * available for a directory. The filesystem is useless if this routine is | ||
263 | * not available for at least the filesystem's root directory. | ||
264 | * | ||
265 | * This routine is passed an incomplete dentry - it must be completed by | ||
266 | * calling d_add(dentry, inode). If the name does not exist, then the | ||
267 | * specified inode must be set to null. An error should only be returned | ||
268 | * when the lookup fails for a reason other than the name not existing. | ||
269 | * Note that the directory inode semaphore is held during the call. | ||
270 | * | ||
271 | * Refer to lookup_dentry() in fs/namei.c | ||
272 | * lookup_dentry() -> lookup() -> real_lookup() -> . | ||
273 | * | ||
274 | * PRE-CONDITIONS | ||
275 | * dir Pointer to inode of parent directory. | ||
276 | * dentry Pointer to dentry to complete. | ||
277 | * nd Pointer to lookup nameidata | ||
278 | * | ||
279 | * POST-CONDITIONS | ||
280 | * <return> Zero on success. | ||
281 | * | ||
282 | * HISTORY | ||
283 | * July 1, 1997 - Andrew E. Mileski | ||
284 | * Written, tested, and released. | ||
285 | */ | ||
286 | |||
287 | static struct dentry *udf_lookup(struct inode *dir, struct dentry *dentry, | 254 | static struct dentry *udf_lookup(struct inode *dir, struct dentry *dentry, |
288 | struct nameidata *nd) | 255 | struct nameidata *nd) |
289 | { | 256 | { |
diff --git a/fs/udf/super.c b/fs/udf/super.c index 3723f04c0799..53e1d6e6dd31 100644 --- a/fs/udf/super.c +++ b/fs/udf/super.c | |||
@@ -1670,22 +1670,6 @@ static void udf_sb_free_bitmap(struct udf_bitmap *bitmap) | |||
1670 | vfree(bitmap); | 1670 | vfree(bitmap); |
1671 | } | 1671 | } |
1672 | 1672 | ||
1673 | /* | ||
1674 | * udf_read_super | ||
1675 | * | ||
1676 | * PURPOSE | ||
1677 | * Complete the specified super block. | ||
1678 | * | ||
1679 | * PRE-CONDITIONS | ||
1680 | * sb Pointer to superblock to complete - never NULL. | ||
1681 | * sb->s_dev Device to read suberblock from. | ||
1682 | * options Pointer to mount options. | ||
1683 | * silent Silent flag. | ||
1684 | * | ||
1685 | * HISTORY | ||
1686 | * July 1, 1997 - Andrew E. Mileski | ||
1687 | * Written, tested, and released. | ||
1688 | */ | ||
1689 | static int udf_fill_super(struct super_block *sb, void *options, int silent) | 1673 | static int udf_fill_super(struct super_block *sb, void *options, int silent) |
1690 | { | 1674 | { |
1691 | int i; | 1675 | int i; |
@@ -1913,19 +1897,6 @@ void udf_warning(struct super_block *sb, const char *function, | |||
1913 | sb->s_id, function, error_buf); | 1897 | sb->s_id, function, error_buf); |
1914 | } | 1898 | } |
1915 | 1899 | ||
1916 | /* | ||
1917 | * udf_put_super | ||
1918 | * | ||
1919 | * PURPOSE | ||
1920 | * Prepare for destruction of the superblock. | ||
1921 | * | ||
1922 | * DESCRIPTION | ||
1923 | * Called before the filesystem is unmounted. | ||
1924 | * | ||
1925 | * HISTORY | ||
1926 | * July 1, 1997 - Andrew E. Mileski | ||
1927 | * Written, tested, and released. | ||
1928 | */ | ||
1929 | static void udf_put_super(struct super_block *sb) | 1900 | static void udf_put_super(struct super_block *sb) |
1930 | { | 1901 | { |
1931 | int i; | 1902 | int i; |
@@ -1961,19 +1932,6 @@ static void udf_put_super(struct super_block *sb) | |||
1961 | sb->s_fs_info = NULL; | 1932 | sb->s_fs_info = NULL; |
1962 | } | 1933 | } |
1963 | 1934 | ||
1964 | /* | ||
1965 | * udf_stat_fs | ||
1966 | * | ||
1967 | * PURPOSE | ||
1968 | * Return info about the filesystem. | ||
1969 | * | ||
1970 | * DESCRIPTION | ||
1971 | * Called by sys_statfs() | ||
1972 | * | ||
1973 | * HISTORY | ||
1974 | * July 1, 1997 - Andrew E. Mileski | ||
1975 | * Written, tested, and released. | ||
1976 | */ | ||
1977 | static int udf_statfs(struct dentry *dentry, struct kstatfs *buf) | 1935 | static int udf_statfs(struct dentry *dentry, struct kstatfs *buf) |
1978 | { | 1936 | { |
1979 | struct super_block *sb = dentry->d_sb; | 1937 | struct super_block *sb = dentry->d_sb; |