diff mbox series

[-next,v2] ubifs: Fix some kernel-doc comments

Message ID 20230712074637.129248-1-yang.lee@linux.alibaba.com
State New
Headers
Series [-next,v2] ubifs: Fix some kernel-doc comments |

Commit Message

Yang Li July 12, 2023, 7:46 a.m. UTC 
  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 <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5848
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---

--change in v2:
According to Zhihao's suggestion, add a more accurate description to @flags.

 fs/ubifs/file.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Zhihao Cheng July 12, 2023, 7:48 a.m. UTC | #1 
在 2023/7/12 15:46, 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 <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=5848
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
> 
> --change in v2:
> According to Zhihao's suggestion, add a more accurate description to @flags.
> 
>   fs/ubifs/file.c | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/fs/ubifs/file.c b/fs/ubifs/file.c
> index 436b27d7c58f..860497532555 100644
> --- a/fs/ubifs/file.c
> +++ b/fs/ubifs/file.c
> @@ -1375,6 +1375,9 @@ 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: time updating control flag determines updating
> + *	    which time fields of @inode
>    *
>    * This function updates time of the inode.
>    */
> 

Reviewed-by: Zhihao Cheng <chengzhihao1@huawei.com>
diff mbox series

Patch

diff --git a/fs/ubifs/file.c b/fs/ubifs/file.c
index 436b27d7c58f..860497532555 100644
--- a/fs/ubifs/file.c
+++ b/fs/ubifs/file.c
@@ -1375,6 +1375,9 @@  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: time updating control flag determines updating
+ *	    which time fields of @inode
  *
  * This function updates time of the inode.
  */