Fix the following reported by make W=1:
fs/nilfs2/btree.c:1871: warning: Function parameter or struct member 'btree' not described in 'nilfs_btree_convert_and_insert'
fs/nilfs2/btree.c:1871: warning: Excess function parameter 'bmap' description in 'nilfs_btree_convert_and_insert'
Signed-off-by: Jeff Johnson <[email protected]>
---
fs/nilfs2/btree.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
index 65659fa0372e..8299839b5129 100644
--- a/fs/nilfs2/btree.c
+++ b/fs/nilfs2/btree.c
@@ -1858,7 +1858,7 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
/**
* nilfs_btree_convert_and_insert -
- * @bmap:
+ * @btree: bmap struct of btree
* @key:
* @ptr:
* @keys:
---
base-commit: dd5a440a31fae6e459c0d6271dddd62825505361
change-id: 20240507-nilfs_btree_convert_and_insert-kdoc-7753c4a6e7c3
On Wed, May 8, 2024 at 7:23 AM Jeff Johnson wrote:
>
> Fix the following reported by make W=1:
>
> fs/nilfs2/btree.c:1871: warning: Function parameter or struct member 'btree' not described in 'nilfs_btree_convert_and_insert'
> fs/nilfs2/btree.c:1871: warning: Excess function parameter 'bmap' description in 'nilfs_btree_convert_and_insert'
>
> Signed-off-by: Jeff Johnson <[email protected]>
> ---
> fs/nilfs2/btree.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
> index 65659fa0372e..8299839b5129 100644
> --- a/fs/nilfs2/btree.c
> +++ b/fs/nilfs2/btree.c
> @@ -1858,7 +1858,7 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
>
> /**
> * nilfs_btree_convert_and_insert -
> - * @bmap:
> + * @btree: bmap struct of btree
> * @key:
> * @ptr:
> * @keys:
>
> ---
> base-commit: dd5a440a31fae6e459c0d6271dddd62825505361
> change-id: 20240507-nilfs_btree_convert_and_insert-kdoc-7753c4a6e7c3
>
Hi Jeff, thank you for posting.
However, a fix for this kernel-doc warnings is already queued in the
mm tree (to be merged in the next merge window).
Please refer to the patch below:
https://lkml.kernel.org/r/[email protected]
https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git/commit/?h=mm-nonmm-stable&id=3da9b9650acc3a2a0c3d3f4542b93d4abe9da1de
Thanks,
Ryusuke Konishi
On 5/7/2024 3:45 PM, Ryusuke Konishi wrote:
> On Wed, May 8, 2024 at 7:23 AM Jeff Johnson wrote:
>>
>> Fix the following reported by make W=1:
>>
>> fs/nilfs2/btree.c:1871: warning: Function parameter or struct member 'btree' not described in 'nilfs_btree_convert_and_insert'
>> fs/nilfs2/btree.c:1871: warning: Excess function parameter 'bmap' description in 'nilfs_btree_convert_and_insert'
>>
>> Signed-off-by: Jeff Johnson <[email protected]>
>> ---
>> fs/nilfs2/btree.c | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/fs/nilfs2/btree.c b/fs/nilfs2/btree.c
>> index 65659fa0372e..8299839b5129 100644
>> --- a/fs/nilfs2/btree.c
>> +++ b/fs/nilfs2/btree.c
>> @@ -1858,7 +1858,7 @@ nilfs_btree_commit_convert_and_insert(struct nilfs_bmap *btree,
>>
>> /**
>> * nilfs_btree_convert_and_insert -
>> - * @bmap:
>> + * @btree: bmap struct of btree
>> * @key:
>> * @ptr:
>> * @keys:
>>
>> ---
>> base-commit: dd5a440a31fae6e459c0d6271dddd62825505361
>> change-id: 20240507-nilfs_btree_convert_and_insert-kdoc-7753c4a6e7c3
>>
>
> Hi Jeff, thank you for posting.
>
> However, a fix for this kernel-doc warnings is already queued in the
> mm tree (to be merged in the next merge window).
>
> Please refer to the patch below:
>
> https://lkml.kernel.org/r/[email protected]
> https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git/commit/?h=mm-nonmm-stable&id=3da9b9650acc3a2a0c3d3f4542b93d4abe9da1de
>
>
> Thanks,
> Ryusuke Konishi
Awesome that others are helping to clean these :)
Guess I should check lore before fixing so that I don't replicate work!
/jeff