lkml.org 
[lkml]   [2021]   [Dec]   [30]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH -next] nvdimm/btt: Fix btt_init() kernel-doc comment
On Thu, Dec 30, 2021 at 05:25:20PM +0800, Yang Li wrote:
> Add the description of @nd_region and remove @maxlane in
> btt_init() kernel-doc comment to remove warnings found
> by running scripts/kernel-doc, which is caused by using 'make W=1'.
> drivers/nvdimm/btt.c:1584: warning: Function parameter or member
> 'nd_region' not described in 'btt_init'
> drivers/nvdimm/btt.c:1584: warning: Excess function parameter 'maxlane'
> description in 'btt_init'
>
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

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

> ---
> drivers/nvdimm/btt.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/nvdimm/btt.c b/drivers/nvdimm/btt.c
> index da3f007a1211..293b8c107817 100644
> --- a/drivers/nvdimm/btt.c
> +++ b/drivers/nvdimm/btt.c
> @@ -1567,7 +1567,7 @@ static void btt_blk_cleanup(struct btt *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: region id and number of lanes possible
> *
> * Initialize a Block Translation Table on a backing device to provide
> * single sector power fail atomicity.
> --
> 2.20.1.7.g153144c
>

\
 
 \ /
  Last update: 2021-12-30 21:38    [W:0.026 / U:0.352 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site