2023-12-07 21:06:28

by Randy Dunlap

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

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 <[email protected]>
Cc: Vishal Verma <[email protected]>
Cc: Dan Williams <[email protected]>
Cc: Dave Jiang <[email protected]>
Cc: Ira Weiny <[email protected]>
Cc: [email protected]
---
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.

2023-12-21 22:14:54

by Ira Weiny

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

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 <[email protected]>
> Cc: Vishal Verma <[email protected]>
> Cc: Dan Williams <[email protected]>
> Cc: Dave Jiang <[email protected]>
> Cc: Ira Weiny <[email protected]>

Reviewed-by: Ira Weiny <[email protected]>

> Cc: [email protected]
> ---
> 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.