Re: [PATCH 2/2] nvdimm-btt: clean up kernel-doc warnings
From: Dave Jiang
Date: Thu Jul 23 2026 - 17:12:51 EST
On 7/21/26 10:21 AM, Randy Dunlap wrote:
> Add one missing kernel-doc description and drop one that shouldn't be
> here in order to avoid kernel-doc warnings:
>
> Warning: ./drivers/nvdimm/btt.h:232 struct member 'nd_region' not described in 'btt'
> Warning: ./drivers/nvdimm/btt.h:232 Excess struct member 'lanes' description in 'btt'
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Reviewed-by: Dave Jiang <dave.jiang@xxxxxxxxx>
> ---
> Cc: Vishal Verma <vishal.l.verma@xxxxxxxxx>
> Cc: Dan Williams <djbw@xxxxxxxxxx>
> Cc: Dave Jiang <dave.jiang@xxxxxxxxx>
> Cc: Alison Schofield <alison.schofield@xxxxxxxxx>
> Cc: Ira Weiny <iweiny@xxxxxxxxxx>
> Cc: nvdimm@xxxxxxxxxxxxxxx
>
> drivers/nvdimm/btt.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> --- linux-next-20260720.orig/drivers/nvdimm/btt.h
> +++ linux-next-20260720/drivers/nvdimm/btt.h
> @@ -210,7 +210,7 @@ struct badblocks;
> * @lbasize: LBA size as requested and presented to upper layers.
> * This is sector_size + size of any metadata.
> * @sector_size: The Linux sector size - 512 or 4096
> - * @lanes: Per-lane spinlocks
> + * @nd_region: &struct nd_region pointer
> * @init_lock: Mutex used for the BTT initialization
> * @init_state: Flag describing the initialization state for the BTT
> * @num_arenas: Number of arenas in the BTT instance