Re: [PATCH 1/3] nvdimm/btt: fix btt_blk_cleanup() kernel-doc

From: Ira Weiny
Date: Thu Dec 21 2023 - 17:14:47 EST


Randy Dunlap wrote:
> Correct the function parameters to prevent kernel-doc warnings:
>
> btt.c:1567: warning: Function parameter or member 'nd_region' not described in 'btt_init'
> btt.c:1567: warning: Excess function parameter 'maxlane' description in 'btt_init'
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Vishal Verma <vishal.l.verma@xxxxxxxxx>
> Cc: Dan Williams <dan.j.williams@xxxxxxxxx>
> Cc: Dave Jiang <dave.jiang@xxxxxxxxx>
> Cc: Ira Weiny <ira.weiny@xxxxxxxxx>

Reviewed-by: Ira Weiny <ira.weiny@xxxxxxxxx>

> Cc: nvdimm@xxxxxxxxxxxxxxx
> ---
> drivers/nvdimm/btt.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/nvdimm/btt.c b/drivers/nvdimm/btt.c
> --- a/drivers/nvdimm/btt.c
> +++ b/drivers/nvdimm/btt.c
> @@ -1550,7 +1550,7 @@ static void btt_blk_cleanup(struct btt *
> * @rawsize: raw size in bytes of the backing device
> * @lbasize: lba size of the backing device
> * @uuid: A uuid for the backing device - this is stored on media
> - * @maxlane: maximum number of parallel requests the device can handle
> + * @nd_region: &struct nd_region for the REGION device
> *
> * Initialize a Block Translation Table on a backing device to provide
> * single sector power fail atomicity.