Skip to contentSkip to conversation

ubifs: Fix some kernel-doc comments

PATCH In review Yang Li 2 participants 2 messages Jul 12, 2023

Subsystems (2)
Memory technology devices (MTD) UBI file system (UBIFS)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH v2 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]>

---

--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(+)
fs/ubifs/file.c +3 -0
index 436b27d7c58f..860497532555 100644
@@ -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.
  */
Signature · 6 lines
2.20.1.7.g153144c


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
reviewer Reviewed-by on v2 1/1
#1 lore raw
Quoted 23 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]>

---

--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(+)
fs/ubifs/file.c +0 -0
index 436b27d7c58f..860497532555 100644

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

Quoted 9 lines
fs/ubifs/file.c +3 -0
@@ -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 <[email protected]>