From: Randy Dunlap <rdunlap@infradead.org>
To: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>,
Alexander Viro <viro@zeniv.linux.org.uk>,
Nathan Chancellor <nathan@kernel.org>,
Nick Desaulniers <ndesaulniers@google.com>,
linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] fs: Eliminate compilation warnings for misc
Date: Tue, 16 Nov 2021 15:00:54 -0800 [thread overview]
Message-ID: <941c9239-3b73-c2ae-83aa-f83d4e587fc8@infradead.org> (raw)
In-Reply-To: <20211116080611.31199-1-tianjia.zhang@linux.alibaba.com>
On 11/16/21 12:06 AM, Tianjia Zhang wrote:
> Eliminate the following clang compilation warnings by adding or
> fixing function comment:
These are from clang? They all appear to be from scripts/kernel-doc.
Can someone please clarify?
thanks.
> fs/file.c:655: warning: Function parameter or member 'fdt' not described in 'last_fd'
> fs/file.c:655: warning: Excess function parameter 'cur_fds' description in 'last_fd'
> fs/file.c:703: warning: Function parameter or member 'flags' not described in '__close_range'
>
> fs/fs_context.c:202: warning: Function parameter or member 'fc' not described in 'generic_parse_monolithic'
> fs/fs_context.c:202: warning: Excess function parameter 'ctx' description in 'generic_parse_monolithic'
> fs/fs_context.c:386: warning: Function parameter or member 'log' not described in 'logfc'
> fs/fs_context.c:386: warning: Function parameter or member 'prefix' not described in 'logfc'
> fs/fs_context.c:386: warning: Function parameter or member 'level' not described in 'logfc'
> fs/fs_context.c:386: warning: Excess function parameter 'fc' description in 'logfc'
>
> fs/namei.c:1044: warning: Function parameter or member 'inode' not described in 'may_follow_link'
>
> fs/read_write.c:88: warning: Function parameter or member 'maxsize' not described in 'generic_file_llseek_size'
> fs/read_write.c:88: warning: Excess function parameter 'size' description in 'generic_file_llseek_size'
>
> Signed-off-by: Tianjia Zhang <tianjia.zhang@linux.alibaba.com>
> ---
> fs/file.c | 3 ++-
> fs/fs_context.c | 6 ++++--
> fs/namei.c | 1 +
> fs/read_write.c | 2 +-
> 4 files changed, 8 insertions(+), 4 deletions(-)
>
> diff --git a/fs/file.c b/fs/file.c
> index 8627dacfc424..ab3b635b0c86 100644
> --- a/fs/file.c
> +++ b/fs/file.c
> @@ -645,7 +645,7 @@ EXPORT_SYMBOL(close_fd); /* for ksys_close() */
>
> /**
> * last_fd - return last valid index into fd table
> - * @cur_fds: files struct
> + * @fdt: fdtable struct
> *
> * Context: Either rcu read lock or files_lock must be held.
> *
> @@ -695,6 +695,7 @@ static inline void __range_close(struct files_struct *cur_fds, unsigned int fd,
> *
> * @fd: starting file descriptor to close
> * @max_fd: last file descriptor to close
> + * @flags: close range flags
> *
> * This closes a range of file descriptors. All file descriptors
> * from @fd up to and including @max_fd are closed.
> diff --git a/fs/fs_context.c b/fs/fs_context.c
> index b7e43a780a62..e94fb7f19d3f 100644
> --- a/fs/fs_context.c
> +++ b/fs/fs_context.c
> @@ -189,7 +189,7 @@ EXPORT_SYMBOL(vfs_parse_fs_string);
>
> /**
> * generic_parse_monolithic - Parse key[=val][,key[=val]]* mount data
> - * @ctx: The superblock configuration to fill in.
> + * @fc: filesystem context
> * @data: The data to parse
> *
> * Parse a blob of data that's in key[=val][,key[=val]]* form. This can be
> @@ -379,7 +379,9 @@ EXPORT_SYMBOL(vfs_dup_fs_context);
>
> /**
> * logfc - Log a message to a filesystem context
> - * @fc: The filesystem context to log to.
> + * @log: The filesystem context to log to.
> + * @prefix: The log prefix.
> + * @level: The log level.
> * @fmt: The format of the buffer.
> */
> void logfc(struct fc_log *log, const char *prefix, char level, const char *fmt, ...)
> diff --git a/fs/namei.c b/fs/namei.c
> index 1f9d2187c765..3bc73b4f39c9 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -1028,6 +1028,7 @@ int sysctl_protected_regular __read_mostly;
> /**
> * may_follow_link - Check symlink following for unsafe situations
> * @nd: nameidata pathwalk data
> + * @inode: inode to check
> *
> * In the case of the sysctl_protected_symlinks sysctl being enabled,
> * CAP_DAC_OVERRIDE needs to be specifically ignored if the symlink is
> diff --git a/fs/read_write.c b/fs/read_write.c
> index 0074afa7ecb3..d7b0f8528930 100644
> --- a/fs/read_write.c
> +++ b/fs/read_write.c
> @@ -71,7 +71,7 @@ EXPORT_SYMBOL(vfs_setpos);
> * @file: file structure to seek on
> * @offset: file offset to seek to
> * @whence: type of seek
> - * @size: max size of this file in file system
> + * @maxsize: max size of this file in file system
> * @eof: offset used for SEEK_END position
> *
> * This is a variant of generic_file_llseek that allows passing in a custom
>
--
~Randy
next prev parent reply other threads:[~2021-11-16 23:01 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-16 8:06 [PATCH] fs: Eliminate compilation warnings for misc Tianjia Zhang
2021-11-16 17:19 ` Matthew Wilcox
2021-11-29 13:04 ` Tianjia Zhang
2021-11-16 23:00 ` Randy Dunlap [this message]
2021-11-29 13:06 ` Tianjia Zhang
2021-11-29 13:19 ` Matthew Wilcox
2021-12-01 9:51 ` Tianjia Zhang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=941c9239-3b73-c2ae-83aa-f83d4e587fc8@infradead.org \
--to=rdunlap@infradead.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nathan@kernel.org \
--cc=ndesaulniers@google.com \
--cc=tianjia.zhang@linux.alibaba.com \
--cc=viro@zeniv.linux.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).