[PATCH] ubifs: fix function comment warning

[PATCH] ubifs: fix function comment warning

[Arnd Bergmann]

From: Arnd Bergmann <arnd@arndb.de>

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.

Reported-by: Zhihao Cheng <chengzhihao1@huawei.com>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202402261559.cYtMOkIn-lkp@intel.com/
Fixes: ec724e534dfd ("ubifs: fix function pointer cast warnings")
Signed-off-by: Arnd Bergmann <arnd@arndb.de>
---
 fs/ubifs/find.c   | 8 ++++----
 fs/ubifs/lprops.c | 2 +-
 2 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/fs/ubifs/find.c b/fs/ubifs/find.c
index 6ebf3c04ac5f..643718906b9f 100644
--- a/fs/ubifs/find.c
+++ b/fs/ubifs/find.c
@@ -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
diff --git a/fs/ubifs/lprops.c b/fs/ubifs/lprops.c
index a11c3dab7e16..8788740ec57f 100644
--- a/fs/ubifs/lprops.c
+++ b/fs/ubifs/lprops.c
@@ -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
-- 
2.39.2

Re: [PATCH] ubifs: fix function comment warning

[Zhihao Cheng]

在 2024/2/26 20:15, Arnd Bergmann 写道:
> From: Arnd Bergmann <arnd@arndb.de>
>
> 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.
>
> Reported-by: Zhihao Cheng <chengzhihao1@huawei.com>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202402261559.cYtMOkIn-lkp@intel.com/
> Fixes: ec724e534dfd ("ubifs: fix function pointer cast warnings")
> Signed-off-by: Arnd Bergmann <arnd@arndb.de>
> ---
>   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.

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

> diff --git a/fs/ubifs/find.c b/fs/ubifs/find.c
> index 6ebf3c04ac5f..643718906b9f 100644
> --- a/fs/ubifs/find.c
> +++ b/fs/ubifs/find.c
> @@ -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
> diff --git a/fs/ubifs/lprops.c b/fs/ubifs/lprops.c
> index a11c3dab7e16..8788740ec57f 100644
> --- a/fs/ubifs/lprops.c
> +++ b/fs/ubifs/lprops.c
> @@ -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