Received-SPF: pass (google.com: domain of linux-kernel+bounces-172257-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Precedence: bulk
MIME-Version: 1.0
References: <20240507-nilfs_btree_convert_and_insert-kdoc-v1-1-bab3514eb753@quicinc.com>
In-Reply-To: <20240507-nilfs_btree_convert_and_insert-kdoc-v1-1-bab3514eb753@quicinc.com>
From: Ryusuke Konishi <konishi.ryusuke@gmail.com>
Date: Wed, 8 May 2024 07:45:03 +0900
Message-ID: <CAKFNMomG+GuKJ53WmdWFONtimhbanKU-B_ZTdt5sEFxcuYxJ3w@mail.gmail.com>
Subject: Re: [PATCH] nilfs2: fix nilfs_btree_commit_convert_and_insert() kernel-doc
To: Jeff Johnson <quic_jjohnson@quicinc.com>
Cc: linux-nilfs@vger.kernel.org, linux-kernel@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Wed, May 8, 2024 at 7:23=E2=80=AFAM Jeff Johnson wrote:
>
> Fix the following reported by make W=3D1:
>
> fs/nilfs2/btree.c:1871: warning: Function parameter or struct member 'btr=
ee' not described in 'nilfs_btree_convert_and_insert'
> fs/nilfs2/btree.c:1871: warning: Excess function parameter 'bmap' descrip=
tion in 'nilfs_btree_convert_and_insert'
>
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  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/20240410075629.3441-3-konishi.ryusuke@gmail.com
https://git.kernel.org/pub/scm/linux/kernel/git/akpm/mm.git/commit/?h=3Dmm-=
nonmm-stable&id=3D3da9b9650acc3a2a0c3d3f4542b93d4abe9da1de


Thanks,
Ryusuke Konishi