Skip to content

Commit 60a9483

Browse files
committed
Merge tag 'warning-fixes-20211005' of git://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs
Pull misc fs warning fixes from David Howells: "The first four patches fix kerneldoc warnings in fscache, afs, 9p and nfs - they're mostly just comment changes, though there's one place in 9p where a comment got detached from the function it was attached to (v9fs_fid_add) and has to switch places with a function that got inserted between (__add_fid). The patch on the end removes an unused symbol in fscache" * tag 'warning-fixes-20211005' of git://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs: fscache: Remove an unused static variable fscache: Fix some kerneldoc warnings shown up by W=1 9p: Fix a bunch of kerneldoc warnings shown up by W=1 afs: Fix kerneldoc warning shown up by W=1 nfs: Fix kerneldoc warning shown up by W=1
2 parents f6274b0 + ef31499 commit 60a9483

File tree

11 files changed

+66
-56
lines changed

11 files changed

+66
-56
lines changed

fs/9p/cache.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ struct fscache_netfs v9fs_cache_netfs = {
2323
.version = 0,
2424
};
2525

26-
/**
26+
/*
2727
* v9fs_random_cachetag - Generate a random tag to be associated
2828
* with a new cache session.
2929
*
@@ -233,7 +233,7 @@ static void v9fs_vfs_readpage_complete(struct page *page, void *data,
233233
unlock_page(page);
234234
}
235235

236-
/**
236+
/*
237237
* __v9fs_readpage_from_fscache - read a page from cache
238238
*
239239
* Returns 0 if the pages are in cache and a BIO is submitted,
@@ -268,7 +268,7 @@ int __v9fs_readpage_from_fscache(struct inode *inode, struct page *page)
268268
}
269269
}
270270

271-
/**
271+
/*
272272
* __v9fs_readpages_from_fscache - read multiple pages from cache
273273
*
274274
* Returns 0 if the pages are in cache and a BIO is submitted,
@@ -308,7 +308,7 @@ int __v9fs_readpages_from_fscache(struct inode *inode,
308308
}
309309
}
310310

311-
/**
311+
/*
312312
* __v9fs_readpage_to_fscache - write a page to the cache
313313
*
314314
*/

fs/9p/fid.c

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@
1919
#include "v9fs_vfs.h"
2020
#include "fid.h"
2121

22+
static inline void __add_fid(struct dentry *dentry, struct p9_fid *fid)
23+
{
24+
hlist_add_head(&fid->dlist, (struct hlist_head *)&dentry->d_fsdata);
25+
}
26+
27+
2228
/**
2329
* v9fs_fid_add - add a fid to a dentry
2430
* @dentry: dentry that the fid is being added to
2531
* @fid: fid to add
2632
*
2733
*/
28-
29-
static inline void __add_fid(struct dentry *dentry, struct p9_fid *fid)
30-
{
31-
hlist_add_head(&fid->dlist, (struct hlist_head *)&dentry->d_fsdata);
32-
}
33-
3434
void v9fs_fid_add(struct dentry *dentry, struct p9_fid *fid)
3535
{
3636
spin_lock(&dentry->d_lock);
@@ -67,7 +67,7 @@ static struct p9_fid *v9fs_fid_find_inode(struct inode *inode, kuid_t uid)
6767

6868
/**
6969
* v9fs_open_fid_add - add an open fid to an inode
70-
* @dentry: inode that the fid is being added to
70+
* @inode: inode that the fid is being added to
7171
* @fid: fid to add
7272
*
7373
*/

fs/9p/v9fs.c

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ int v9fs_show_options(struct seq_file *m, struct dentry *root)
155155
/**
156156
* v9fs_parse_options - parse mount options into session structure
157157
* @v9ses: existing v9fs session information
158+
* @opts: The mount option string
158159
*
159160
* Return 0 upon success, -ERRNO upon failure.
160161
*/
@@ -542,12 +543,9 @@ extern int v9fs_error_init(void);
542543
static struct kobject *v9fs_kobj;
543544

544545
#ifdef CONFIG_9P_FSCACHE
545-
/**
546-
* caches_show - list caches associated with a session
547-
*
548-
* Returns the size of buffer written.
546+
/*
547+
* List caches associated with a session
549548
*/
550-
551549
static ssize_t caches_show(struct kobject *kobj,
552550
struct kobj_attribute *attr,
553551
char *buf)

fs/9p/vfs_addr.c

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,7 @@
3030

3131
/**
3232
* v9fs_fid_readpage - read an entire page in from 9P
33-
*
34-
* @fid: fid being read
33+
* @data: Opaque pointer to the fid being read
3534
* @page: structure to page
3635
*
3736
*/
@@ -116,6 +115,8 @@ static int v9fs_vfs_readpages(struct file *filp, struct address_space *mapping,
116115

117116
/**
118117
* v9fs_release_page - release the private state associated with a page
118+
* @page: The page to be released
119+
* @gfp: The caller's allocation restrictions
119120
*
120121
* Returns 1 if the page can be released, false otherwise.
121122
*/
@@ -129,9 +130,9 @@ static int v9fs_release_page(struct page *page, gfp_t gfp)
129130

130131
/**
131132
* v9fs_invalidate_page - Invalidate a page completely or partially
132-
*
133-
* @page: structure to page
134-
* @offset: offset in the page
133+
* @page: The page to be invalidated
134+
* @offset: offset of the invalidated region
135+
* @length: length of the invalidated region
135136
*/
136137

137138
static void v9fs_invalidate_page(struct page *page, unsigned int offset,
@@ -199,6 +200,8 @@ static int v9fs_vfs_writepage(struct page *page, struct writeback_control *wbc)
199200

200201
/**
201202
* v9fs_launder_page - Writeback a dirty page
203+
* @page: The page to be cleaned up
204+
*
202205
* Returns 0 on success.
203206
*/
204207

@@ -219,6 +222,7 @@ static int v9fs_launder_page(struct page *page)
219222
/**
220223
* v9fs_direct_IO - 9P address space operation for direct I/O
221224
* @iocb: target I/O control block
225+
* @iter: The data/buffer to use
222226
*
223227
* The presence of v9fs_direct_IO() in the address space ops vector
224228
* allowes open() O_DIRECT flags which would have failed otherwise.

fs/9p/vfs_file.c

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -359,14 +359,11 @@ static int v9fs_file_flock_dotl(struct file *filp, int cmd,
359359
}
360360

361361
/**
362-
* v9fs_file_read - read from a file
363-
* @filp: file pointer to read
364-
* @udata: user data buffer to read data into
365-
* @count: size of buffer
366-
* @offset: offset at which to read data
362+
* v9fs_file_read_iter - read from a file
363+
* @iocb: The operation parameters
364+
* @to: The buffer to read into
367365
*
368366
*/
369-
370367
static ssize_t
371368
v9fs_file_read_iter(struct kiocb *iocb, struct iov_iter *to)
372369
{
@@ -388,11 +385,9 @@ v9fs_file_read_iter(struct kiocb *iocb, struct iov_iter *to)
388385
}
389386

390387
/**
391-
* v9fs_file_write - write to a file
392-
* @filp: file pointer to write
393-
* @data: data buffer to write data from
394-
* @count: size of buffer
395-
* @offset: offset at which to write data
388+
* v9fs_file_write_iter - write to a file
389+
* @iocb: The operation parameters
390+
* @from: The data to write
396391
*
397392
*/
398393
static ssize_t
@@ -561,11 +556,9 @@ v9fs_vm_page_mkwrite(struct vm_fault *vmf)
561556
}
562557

563558
/**
564-
* v9fs_mmap_file_read - read from a file
565-
* @filp: file pointer to read
566-
* @data: user data buffer to read data into
567-
* @count: size of buffer
568-
* @offset: offset at which to read data
559+
* v9fs_mmap_file_read_iter - read from a file
560+
* @iocb: The operation parameters
561+
* @to: The buffer to read into
569562
*
570563
*/
571564
static ssize_t
@@ -576,11 +569,9 @@ v9fs_mmap_file_read_iter(struct kiocb *iocb, struct iov_iter *to)
576569
}
577570

578571
/**
579-
* v9fs_mmap_file_write - write to a file
580-
* @filp: file pointer to write
581-
* @data: data buffer to write data from
582-
* @count: size of buffer
583-
* @offset: offset at which to write data
572+
* v9fs_mmap_file_write_iter - write to a file
573+
* @iocb: The operation parameters
574+
* @from: The data to write
584575
*
585576
*/
586577
static ssize_t

fs/9p/vfs_inode.c

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ v9fs_blank_wstat(struct p9_wstat *wstat)
218218

219219
/**
220220
* v9fs_alloc_inode - helper function to allocate an inode
221-
*
221+
* @sb: The superblock to allocate the inode from
222222
*/
223223
struct inode *v9fs_alloc_inode(struct super_block *sb)
224224
{
@@ -238,7 +238,7 @@ struct inode *v9fs_alloc_inode(struct super_block *sb)
238238

239239
/**
240240
* v9fs_free_inode - destroy an inode
241-
*
241+
* @inode: The inode to be freed
242242
*/
243243

244244
void v9fs_free_inode(struct inode *inode)
@@ -343,7 +343,7 @@ int v9fs_init_inode(struct v9fs_session_info *v9ses,
343343
* v9fs_get_inode - helper function to setup an inode
344344
* @sb: superblock
345345
* @mode: mode to setup inode with
346-
*
346+
* @rdev: The device numbers to set
347347
*/
348348

349349
struct inode *v9fs_get_inode(struct super_block *sb, umode_t mode, dev_t rdev)
@@ -369,7 +369,7 @@ struct inode *v9fs_get_inode(struct super_block *sb, umode_t mode, dev_t rdev)
369369
}
370370

371371
/**
372-
* v9fs_clear_inode - release an inode
372+
* v9fs_evict_inode - Remove an inode from the inode cache
373373
* @inode: inode to release
374374
*
375375
*/
@@ -665,14 +665,15 @@ v9fs_create(struct v9fs_session_info *v9ses, struct inode *dir,
665665

666666
/**
667667
* v9fs_vfs_create - VFS hook to create a regular file
668+
* @mnt_userns: The user namespace of the mount
669+
* @dir: The parent directory
670+
* @dentry: The name of file to be created
671+
* @mode: The UNIX file mode to set
672+
* @excl: True if the file must not yet exist
668673
*
669674
* open(.., O_CREAT) is handled in v9fs_vfs_atomic_open(). This is only called
670675
* for mknod(2).
671676
*
672-
* @dir: directory inode that is being created
673-
* @dentry: dentry that is being deleted
674-
* @mode: create permissions
675-
*
676677
*/
677678

678679
static int
@@ -696,6 +697,7 @@ v9fs_vfs_create(struct user_namespace *mnt_userns, struct inode *dir,
696697

697698
/**
698699
* v9fs_vfs_mkdir - VFS mkdir hook to create a directory
700+
* @mnt_userns: The user namespace of the mount
699701
* @dir: inode that is being unlinked
700702
* @dentry: dentry that is being unlinked
701703
* @mode: mode for new directory
@@ -900,10 +902,12 @@ int v9fs_vfs_rmdir(struct inode *i, struct dentry *d)
900902

901903
/**
902904
* v9fs_vfs_rename - VFS hook to rename an inode
905+
* @mnt_userns: The user namespace of the mount
903906
* @old_dir: old dir inode
904907
* @old_dentry: old dentry
905908
* @new_dir: new dir inode
906909
* @new_dentry: new dentry
910+
* @flags: RENAME_* flags
907911
*
908912
*/
909913

@@ -1009,6 +1013,7 @@ v9fs_vfs_rename(struct user_namespace *mnt_userns, struct inode *old_dir,
10091013

10101014
/**
10111015
* v9fs_vfs_getattr - retrieve file metadata
1016+
* @mnt_userns: The user namespace of the mount
10121017
* @path: Object to query
10131018
* @stat: metadata structure to populate
10141019
* @request_mask: Mask of STATX_xxx flags indicating the caller's interests
@@ -1050,6 +1055,7 @@ v9fs_vfs_getattr(struct user_namespace *mnt_userns, const struct path *path,
10501055

10511056
/**
10521057
* v9fs_vfs_setattr - set file metadata
1058+
* @mnt_userns: The user namespace of the mount
10531059
* @dentry: file whose metadata to set
10541060
* @iattr: metadata assignment structure
10551061
*
@@ -1285,6 +1291,7 @@ static int v9fs_vfs_mkspecial(struct inode *dir, struct dentry *dentry,
12851291

12861292
/**
12871293
* v9fs_vfs_symlink - helper function to create symlinks
1294+
* @mnt_userns: The user namespace of the mount
12881295
* @dir: directory inode containing symlink
12891296
* @dentry: dentry for symlink
12901297
* @symname: symlink data
@@ -1340,6 +1347,7 @@ v9fs_vfs_link(struct dentry *old_dentry, struct inode *dir,
13401347

13411348
/**
13421349
* v9fs_vfs_mknod - create a special file
1350+
* @mnt_userns: The user namespace of the mount
13431351
* @dir: inode destination for new link
13441352
* @dentry: dentry for file
13451353
* @mode: mode for creation

fs/9p/vfs_inode_dotl.c

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ v9fs_vfs_mknod_dotl(struct user_namespace *mnt_userns, struct inode *dir,
3737
struct dentry *dentry, umode_t omode, dev_t rdev);
3838

3939
/**
40-
* v9fs_get_fsgid_for_create - Helper function to get the gid for creating a
40+
* v9fs_get_fsgid_for_create - Helper function to get the gid for a new object
41+
* @dir_inode: The directory inode
42+
*
43+
* Helper function to get the gid for creating a
4144
* new file system object. This checks the S_ISGID to determine the owning
4245
* group of the new file system object.
4346
*/
@@ -211,12 +214,13 @@ int v9fs_open_to_dotl_flags(int flags)
211214

212215
/**
213216
* v9fs_vfs_create_dotl - VFS hook to create files for 9P2000.L protocol.
217+
* @mnt_userns: The user namespace of the mount
214218
* @dir: directory inode that is being created
215219
* @dentry: dentry that is being deleted
216220
* @omode: create permissions
221+
* @excl: True if the file must not yet exist
217222
*
218223
*/
219-
220224
static int
221225
v9fs_vfs_create_dotl(struct user_namespace *mnt_userns, struct inode *dir,
222226
struct dentry *dentry, umode_t omode, bool excl)
@@ -361,6 +365,7 @@ v9fs_vfs_atomic_open_dotl(struct inode *dir, struct dentry *dentry,
361365

362366
/**
363367
* v9fs_vfs_mkdir_dotl - VFS mkdir hook to create a directory
368+
* @mnt_userns: The user namespace of the mount
364369
* @dir: inode that is being unlinked
365370
* @dentry: dentry that is being unlinked
366371
* @omode: mode for new directory
@@ -537,6 +542,7 @@ static int v9fs_mapped_iattr_valid(int iattr_valid)
537542

538543
/**
539544
* v9fs_vfs_setattr_dotl - set file metadata
545+
* @mnt_userns: The user namespace of the mount
540546
* @dentry: file whose metadata to set
541547
* @iattr: metadata assignment structure
542548
*
@@ -816,6 +822,7 @@ v9fs_vfs_link_dotl(struct dentry *old_dentry, struct inode *dir,
816822

817823
/**
818824
* v9fs_vfs_mknod_dotl - create a special file
825+
* @mnt_userns: The user namespace of the mount
819826
* @dir: inode destination for new link
820827
* @dentry: dentry for file
821828
* @omode: mode for creation

fs/afs/dir_silly.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ static int afs_do_silly_rename(struct afs_vnode *dvnode, struct afs_vnode *vnode
8686
return afs_do_sync_operation(op);
8787
}
8888

89-
/**
90-
* afs_sillyrename - Perform a silly-rename of a dentry
89+
/*
90+
* Perform silly-rename of a dentry.
9191
*
9292
* AFS is stateless and the server doesn't know when the client is holding a
9393
* file open. To prevent application problems when a file is unlinked while

fs/fscache/object.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ static WORK_STATE(INIT_OBJECT, "INIT", fscache_initialise_object);
7777
static WORK_STATE(PARENT_READY, "PRDY", fscache_parent_ready);
7878
static WORK_STATE(ABORT_INIT, "ABRT", fscache_abort_initialisation);
7979
static WORK_STATE(LOOK_UP_OBJECT, "LOOK", fscache_look_up_object);
80-
static WORK_STATE(CREATE_OBJECT, "CRTO", fscache_look_up_object);
8180
static WORK_STATE(OBJECT_AVAILABLE, "AVBL", fscache_object_available);
8281
static WORK_STATE(JUMPSTART_DEPS, "JUMP", fscache_jumpstart_dependents);
8382

@@ -907,6 +906,7 @@ static void fscache_dequeue_object(struct fscache_object *object)
907906
* @object: The object to ask about
908907
* @data: The auxiliary data for the object
909908
* @datalen: The size of the auxiliary data
909+
* @object_size: The size of the object according to the server.
910910
*
911911
* This function consults the netfs about the coherency state of an object.
912912
* The caller must be holding a ref on cookie->n_active (held by

0 commit comments

Comments
 (0)