Skip to contentSkip to conversation

ubifs: fix function comment warning

PATCH In review Arnd Bergmann 2 participants 2 messages Feb 26, 2024 – Feb 27, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ubifs: fix function comment warning

From: Arnd Bergmann <[email protected]>

My previous fix introduced a new W=1 warning for the kerneldoc style comments:

fs/ubifs/find.c:86: warning: Function parameter or struct member 'arg' not described in 'scan_for_dirty_cb'

Adjust the comments to the argument names.

---
 fs/ubifs/find.c   | 8 ++++----
 fs/ubifs/lprops.c | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)
fs/ubifs/find.c +4 -4
index 6ebf3c04ac5f..643718906b9f 100644
@@ -73,7 +73,7 @@ static int valuable(struct ubifs_info *c, const struct ubifs_lprops *lprops)
  * @c: the UBIFS file-system description object
  * @lprops: LEB properties to scan
  * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
  *
  * This function returns a code that indicates whether the scan should continue
  * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -340,7 +340,7 @@ int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
  * @c: the UBIFS file-system description object
  * @lprops: LEB properties to scan
  * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
  *
  * This function returns a code that indicates whether the scan should continue
  * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -581,7 +581,7 @@ int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
  * @c: the UBIFS file-system description object
  * @lprops: LEB properties to scan
  * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
  *
  * This function returns a code that indicates whether the scan should continue
  * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -773,7 +773,7 @@ int ubifs_save_dirty_idx_lnums(struct ubifs_info *c)
  * @c: the UBIFS file-system description object
  * @lprops: LEB properties to scan
  * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
  *
  * This function returns a code that indicates whether the scan should continue
  * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
fs/ubifs/lprops.c +1 -1
index a11c3dab7e16..8788740ec57f 100644
@@ -1005,7 +1005,7 @@ void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
  * @c: the UBIFS file-system description object
  * @lp: LEB properties to scan
  * @in_tree: whether the LEB properties are in main memory
- * @lst: lprops statistics to update
+ * @arg: lprops statistics to update
  *
  * This function returns a code that indicates whether the scan should continue
  * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
Signature · 1 line
2.39.2
reviewer Reviewed-by on v1 1/1
#1 lore raw
Quoted 14 lines · Arnd Bergmann

From: Arnd Bergmann <[email protected]>

My previous fix introduced a new W=1 warning for the kerneldoc style comments:

fs/ubifs/find.c:86: warning: Function parameter or struct member 'arg' not described in 'scan_for_dirty_cb'

Adjust the comments to the argument names.

Quoted 4 lines
---
  fs/ubifs/find.c   | 8 ++++----
  fs/ubifs/lprops.c | 2 +-
  2 files changed, 5 insertions(+), 5 deletions(-)

The commit title could be more detailed(eg. add function name) in next time.

Quoted 53 lines
fs/ubifs/find.c +4 -4
index 6ebf3c04ac5f..643718906b9f 100644
@@ -73,7 +73,7 @@ static int valuable(struct ubifs_info *c, const struct ubifs_lprops *lprops)
   * @c: the UBIFS file-system description object
   * @lprops: LEB properties to scan
   * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
   *
   * This function returns a code that indicates whether the scan should continue
   * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -340,7 +340,7 @@ int ubifs_find_dirty_leb(struct ubifs_info *c, struct ubifs_lprops *ret_lp,
   * @c: the UBIFS file-system description object
   * @lprops: LEB properties to scan
   * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
   *
   * This function returns a code that indicates whether the scan should continue
   * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -581,7 +581,7 @@ int ubifs_find_free_space(struct ubifs_info *c, int min_space, int *offs,
   * @c: the UBIFS file-system description object
   * @lprops: LEB properties to scan
   * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
   *
   * This function returns a code that indicates whether the scan should continue
   * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
@@ -773,7 +773,7 @@ int ubifs_save_dirty_idx_lnums(struct ubifs_info *c)
   * @c: the UBIFS file-system description object
   * @lprops: LEB properties to scan
   * @in_tree: whether the LEB properties are in main memory
- * @data: information passed to and from the caller of the scan
+ * @arg: information passed to and from the caller of the scan
   *
   * This function returns a code that indicates whether the scan should continue
   * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree
fs/ubifs/lprops.c +1 -1
index a11c3dab7e16..8788740ec57f 100644
@@ -1005,7 +1005,7 @@ void dbg_check_heap(struct ubifs_info *c, struct ubifs_lpt_heap *heap, int cat,
   * @c: the UBIFS file-system description object
   * @lp: LEB properties to scan
   * @in_tree: whether the LEB properties are in main memory
- * @lst: lprops statistics to update
+ * @arg: lprops statistics to update
   *
   * This function returns a code that indicates whether the scan should continue
   * (%LPT_SCAN_CONTINUE), whether the LEB properties should be added to the tree