2023-07-12 07:39:36

by Yang Li

Subject: [PATCH -next] ubifs: Fix some kernel-doc comments

Add description of @time and @flags in ubifs_update_time().

to silence the warnings:
fs/ubifs/file.c:1383: warning: Function parameter or member 'time' not described in 'ubifs_update_time'
fs/ubifs/file.c:1383: warning: Function parameter or member 'flags' not described in 'ubifs_update_time'

Reported-by: Abaci Robot <[email protected]>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5848
Signed-off-by: Yang Li <[email protected]>
---
fs/ubifs/file.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/fs/ubifs/file.c b/fs/ubifs/file.c
index 436b27d7c58f..5e86ef1be698 100644
--- a/fs/ubifs/file.c
+++ b/fs/ubifs/file.c
@@ -1375,6 +1375,8 @@ static inline int mctime_update_needed(const struct inode *inode,
/**
* ubifs_update_time - update time of inode.
* @inode: inode to update
+ * @time: timespec structure to hold the current time value
+ * @flags: file time flag
*
* This function updates time of the inode.
*/
--
2.20.1.7.g153144c

2023-07-12 07:39:37

by Zhihao Cheng

Subject: Re: [PATCH -next] ubifs: Fix some kernel-doc comments

?? 2023/7/12 15:12, Yang Li д??:
> Add description of @time and @flags in ubifs_update_time().
>
> to silence the warnings:
> fs/ubifs/file.c:1383: warning: Function parameter or member 'time' not described in 'ubifs_update_time'
> fs/ubifs/file.c:1383: warning: Function parameter or member 'flags' not described in 'ubifs_update_time'
>
> Reported-by: Abaci Robot <[email protected]>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5848
> Signed-off-by: Yang Li <[email protected]>
> ---
> fs/ubifs/file.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/fs/ubifs/file.c b/fs/ubifs/file.c
> index 436b27d7c58f..5e86ef1be698 100644
> --- a/fs/ubifs/file.c
> +++ b/fs/ubifs/file.c
> @@ -1375,6 +1375,8 @@ static inline int mctime_update_needed(const struct inode *inode,
> /**
> * ubifs_update_time - update time of inode.
> * @inode: inode to update
> + * @time: timespec structure to hold the current time value
> + * @flags: file time flag

flags: time updating control flag determines updating which time fields
of @inode

> *
> * This function updates time of the inode.
> */
>