Skip to contentSkip to conversation

ubifs: Fix some kernel-doc comments

PATCH Superseded Yang Li 2 participants 2 messages Jul 12, 2023

Subsystems (2)
Memory technology devices (MTD) UBI file system (UBIFS)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 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(+)
fs/ubifs/file.c +2 -0
index 436b27d7c58f..5e86ef1be698 100644
@@ -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.
  */
Signature · 1 line
2.20.1.7.g153144c
reviewer
#1 lore raw
Quoted 18 lines · 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(+)
fs/ubifs/file.c +0 -0
index 436b27d7c58f..5e86ef1be698 100644

fs/ubifs/file.c static inline int mctime_update_needed(const struct inode *inode, · line 1379

Quoted 5 lines
fs/ubifs/file.c +2 -0
@@ -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

Quoted 4 lines
fs/ubifs/file.c +0 -0
   *
   * This function updates time of the inode.
   */