Commit 8d99c113 authored by Randy Dunlap's avatar Randy Dunlap Committed by Steve French
Browse files

ksmbd: vfs: fix all kernel-doc warnings 



Fix all kernel-doc warnings in vfs.c:

vfs.c:54: warning: Function parameter or member 'parent' not described in 'ksmbd_vfs_lock_parent'
vfs.c:54: warning: Function parameter or member 'child' not described in 'ksmbd_vfs_lock_parent'
vfs.c:54: warning: No description found for return value of 'ksmbd_vfs_lock_parent'
vfs.c:372: warning: Function parameter or member 'fp' not described in 'ksmbd_vfs_read'
vfs.c:372: warning: Excess function parameter 'fid' description in 'ksmbd_vfs_read'
vfs.c:489: warning: Function parameter or member 'fp' not described in 'ksmbd_vfs_write'
vfs.c:489: warning: Excess function parameter 'fid' description in 'ksmbd_vfs_write'
vfs.c:555: warning: Function parameter or member 'path' not described in 'ksmbd_vfs_getattr'
vfs.c:555: warning: Function parameter or member 'stat' not described in 'ksmbd_vfs_getattr'
vfs.c:555: warning: Excess function parameter 'work' description in 'ksmbd_vfs_getattr'
vfs.c:555: warning: Excess function parameter 'fid' description in 'ksmbd_vfs_getattr'
vfs.c:555: warning: Excess function parameter 'attrs' description in 'ksmbd_vfs_getattr'
vfs.c:572: warning: Function parameter or member 'p_id' not described in 'ksmbd_vfs_fsync'
vfs.c:595: warning: Function parameter or member 'work' not described in 'ksmbd_vfs_remove_file'
vfs.c:595: warning: Function parameter or member 'path' not described in 'ksmbd_vfs_remove_file'
vfs.c:595: warning: Excess function parameter 'name' description in 'ksmbd_vfs_remove_file'
vfs.c:633: warning: Function parameter or member 'work' not described in 'ksmbd_vfs_link'
vfs.c:805: warning: Function parameter or member 'fp' not described in 'ksmbd_vfs_truncate'
vfs.c:805: warning: Excess function parameter 'fid' description in 'ksmbd_vfs_truncate'
vfs.c:846: warning: Excess function parameter 'size' description in 'ksmbd_vfs_listxattr'
vfs.c:953: warning: Function parameter or member 'option' not described in 'ksmbd_vfs_set_fadvise'
vfs.c:953: warning: Excess function parameter 'options' description in 'ksmbd_vfs_set_fadvise'
vfs.c:1167: warning: Function parameter or member 'um' not described in 'ksmbd_vfs_lookup_in_dir'
vfs.c:1203: warning: Function parameter or member 'work' not described in 'ksmbd_vfs_kern_path_locked'
vfs.c:1641: warning: No description found for return value of 'ksmbd_vfs_init_kstat'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Namjae Jeon <linkinjeon@kernel.org>
Cc: Steve French <sfrench@samba.org>
Cc: Sergey Senozhatsky <senozhatsky@chromium.org>
Cc: Tom Talpey <tom@talpey.com>
Cc: linux-cifs@vger.kernel.org
Acked-by: default avatarNamjae Jeon <linkinjeon@kernel.org>
Signed-off-by: default avatarSteve French <stfrench@microsoft.com>
parent b4068f1e

fs/smb/server/vfs.c

+18 −10
Original line number Diff line number Diff line
@@ -49,6 +49,10 @@ static void ksmbd_vfs_inherit_owner(struct ksmbd_work *work, 


/**

 * ksmbd_vfs_lock_parent() - lock parent dentry if it is stable

 * @parent: parent dentry

 * @child: child dentry

 *

 * Returns: %0 on success, %-ENOENT if the parent dentry is not stable

 */

int ksmbd_vfs_lock_parent(struct dentry *parent, struct dentry *child)

{
@@ -360,7 +364,7 @@ static int check_lock_range(struct file *filp, loff_t start, loff_t end, 
/**

 * ksmbd_vfs_read() - vfs helper for smb file read

 * @work:	smb work

 * @fid:	file id of open file

 * @fp:		ksmbd file pointer

 * @count:	read byte count

 * @pos:	file pos

 * @rbuf:	read data buffer
@@ -474,7 +478,7 @@ static int ksmbd_vfs_stream_write(struct ksmbd_file *fp, char *buf, loff_t *pos, 
/**

 * ksmbd_vfs_write() - vfs helper for smb file write

 * @work:	work

 * @fid:	file id of open file

 * @fp:		ksmbd file pointer

 * @buf:	buf containing data for writing

 * @count:	read byte count

 * @pos:	file pos
@@ -545,10 +549,8 @@ int ksmbd_vfs_write(struct ksmbd_work *work, struct ksmbd_file *fp, 


/**

 * ksmbd_vfs_getattr() - vfs helper for smb getattr

 * @work:	work

 * @fid:	file id of open file

 * @attrs:	inode attributes

 *

 * @path:	path of dentry

 * @stat:	pointer to returned kernel stat structure

 * Return:	0 on success, otherwise error

 */

int ksmbd_vfs_getattr(const struct path *path, struct kstat *stat)
@@ -565,6 +567,7 @@ int ksmbd_vfs_getattr(const struct path *path, struct kstat *stat) 
 * ksmbd_vfs_fsync() - vfs helper for smb fsync

 * @work:	work

 * @fid:	file id of open file

 * @p_id:	persistent file id

 *

 * Return:	0 on success, otherwise error

 */
@@ -587,7 +590,8 @@ int ksmbd_vfs_fsync(struct ksmbd_work *work, u64 fid, u64 p_id) 


/**

 * ksmbd_vfs_remove_file() - vfs helper for smb rmdir or unlink

 * @name:	directory or file name that is relative to share

 * @work:	work

 * @path:	path of dentry

 *

 * Return:	0 on success, otherwise error

 */
@@ -623,6 +627,7 @@ int ksmbd_vfs_remove_file(struct ksmbd_work *work, const struct path *path) 


/**

 * ksmbd_vfs_link() - vfs helper for creating smb hardlink

 * @work:	work

 * @oldname:	source file name

 * @newname:	hardlink name that is relative to share

 *
@@ -795,7 +800,7 @@ int ksmbd_vfs_rename(struct ksmbd_work *work, const struct path *old_path, 
/**

 * ksmbd_vfs_truncate() - vfs helper for smb file truncate

 * @work:	work

 * @fid:	file id of old file

 * @fp:		ksmbd file pointer

 * @size:	truncate to given size

 *

 * Return:	0 on success, otherwise error
@@ -838,7 +843,6 @@ int ksmbd_vfs_truncate(struct ksmbd_work *work, 
 * ksmbd_vfs_listxattr() - vfs helper for smb list extended attributes

 * @dentry:	dentry of file for listing xattrs

 * @list:	destination buffer

 * @size:	destination buffer length

 *

 * Return:	xattr list length on success, otherwise error

 */
@@ -947,7 +951,7 @@ int ksmbd_vfs_setxattr(struct mnt_idmap *idmap, 
/**

 * ksmbd_vfs_set_fadvise() - convert smb IO caching options to linux options

 * @filp:	file pointer for IO

 * @options:	smb IO options

 * @option:	smb IO options

 */

void ksmbd_vfs_set_fadvise(struct file *filp, __le32 option)

{
@@ -1159,6 +1163,7 @@ static bool __caseless_lookup(struct dir_context *ctx, const char *name, 
 * @dir:	path info

 * @name:	filename to lookup

 * @namelen:	filename length

 * @um:		&struct unicode_map to use

 *

 * Return:	0 on success, otherwise error

 */
@@ -1189,6 +1194,7 @@ static int ksmbd_vfs_lookup_in_dir(const struct path *dir, char *name, 


/**

 * ksmbd_vfs_kern_path_locked() - lookup a file and get path info

 * @work:	work

 * @name:		file path that is relative to share

 * @flags:		lookup flags

 * @parent_path:	if lookup succeed, return parent_path info
@@ -1636,6 +1642,8 @@ int ksmbd_vfs_get_dos_attrib_xattr(struct mnt_idmap *idmap, 
 * ksmbd_vfs_init_kstat() - convert unix stat information to smb stat format

 * @p:          destination buffer

 * @ksmbd_kstat:      ksmbd kstat wrapper

 *

 * Returns: pointer to the converted &struct file_directory_info

 */

void *ksmbd_vfs_init_kstat(char **p, struct ksmbd_kstat *ksmbd_kstat)

{