Date:   Thu, 23 Feb 2023 15:06:06 -0800
From:   Ira Weiny <ira.weiny@intel.com>
To:     Yang Li <yang.lee@linux.alibaba.com>, <dan.j.williams@intel.com>
CC:     <vishal.l.verma@intel.com>, <dave.jiang@intel.com>,
        <ira.weiny@intel.com>, <nvdimm@lists.linux.dev>,
        <linux-kernel@vger.kernel.org>,
        Yang Li <yang.lee@linux.alibaba.com>,
        Abaci Robot <abaci@linux.alibaba.com>
Subject: Re: [PATCH -next] libnvdimm: Fix some kernel-doc comments
Message-ID: <63f7f15ecb595_20753229494@iweiny-mobl.notmuch>
References: <20230220071256.72513-1-yang.lee@linux.alibaba.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20230220071256.72513-1-yang.lee@linux.alibaba.com>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?AGjqcIJbO16Uv2Dlotjb6gxmIgYNyuIKTTgbkKCO7I5nQZH01SeXoYWOCdg2?=
 =?us-ascii?Q?IsSyNNsVwixkeEdNhjSGClfSv4BuT6CKZg8tO3gKJicYcQuenCO+axlXKbwN?=
 =?us-ascii?Q?RKtLnoqQ7IUT21BxxAr1YB+ZSYpN5nYxILszoFPZkJbGHTZzl0JdEifG8ozS?=
 =?us-ascii?Q?2CyJB/waqIdgDAv3vm66mIhrpYUqLufgwLe3mhx2QkHprtEhoBkUBmRPsoiy?=
 =?us-ascii?Q?xZqpERCY8hJJG6zR9zMbwrxjThel5zPQyol4CoUdZQx4VdtM78SzE4iqkXeY?=
 =?us-ascii?Q?dX7e0LFRpw6AAZI3fpEib7mx8oxaQ0NtBPe52ICJCwqwA1lhpZz0SjxV3fEO?=
 =?us-ascii?Q?qlyXPRItD33O1LjqSNewjmLiRIiFqyMyKcLDtkanZn9LQjdQUL+2FtRG1vWa?=
 =?us-ascii?Q?HkZ8vEgBaQBbhXNB/4YuRWxNOpryKzvgB0a3pm98CnyRP7gj7vctz/USp5GD?=
 =?us-ascii?Q?6GumHdNANYjLlRxQZS6J+YIE0iFsmw4d5PJBH6N1naea0yXqF2ntVICdvaxm?=
 =?us-ascii?Q?IRi2vsqMXlNnoNSa1TTucTQFsMk4Ehjyf9V+nKsMOYZC+qQ2dHFKmilyaKrU?=
 =?us-ascii?Q?DUu+y1UUpUz7SRWlfxEYgDXPk3W3hN7WAgCpM+fza5zH9l5Anf2YXcioH1LF?=
 =?us-ascii?Q?XdLmVa04JyJjkV/B7V5MlfWCZWfUrjcYlruzTWP64BjXwBMch2vAY9Hvf5ve?=
 =?us-ascii?Q?QUFYqymRHLwrJc4HN71WxJ5E8+PrBekwzyvt3Vw06i6e1N7ZNum3j0t6D/h9?=
 =?us-ascii?Q?8YOTGlPeyBUIH9lmCFIqinqsQfYE7Zg0SfqpOjMh/0e0Tr/KqkehmS7JKjcr?=
 =?us-ascii?Q?RMMM24br5tGtvEW+Te29WLlcHa8Cu1i/uxOyr1zqO+W33XW2LZ2lQwTRs5ER?=
 =?us-ascii?Q?M1SsUtuKdEFYvLYQDNh953nUjP6yulLvDneFyDGFt9R6pFuga6bvd4Y6i8ep?=
 =?us-ascii?Q?ZjxyeN1+/yBrPku7SvD5EkG4oejcDXgVkcdYbM1UbZ31wF36vfj7iXMDT0EP?=
 =?us-ascii?Q?s9KLjUKPcDm8u77rj2/1NNMyxrM/JQh/Zt/xOAmx9J6o4BoezUf+RsA7fNi3?=
 =?us-ascii?Q?CTO59MwE2w3sELuh/7QIY0NWQwv4F+yZYmoG5pVlWoLXvaJhlFRLOk4tV5K7?=
 =?us-ascii?Q?TR/UVrD+ARDxJQoK3MY1h7gNxXr/yubOn20JUk8/+u0GXj8QMiWMOXeEXHkb?=
 =?us-ascii?Q?2cDoBhve+TrfBj5aOZ1BroUd7UYFzZ+5QSGRFFnKdiOr4KZF8ordYLri4V07?=
 =?us-ascii?Q?QMFiZRvKZJWRls24TOE1CDWwruMD1X8RRej4GAUzY535JNjvDsmiYkSOXeIz?=
 =?us-ascii?Q?p2guwOriUbB3cGWRAAt7IRmflWum52Lmo6yNQ6AuWmmyK6UMB6Lb2XNWwbGO?=
 =?us-ascii?Q?8GTHLrRt9PqcwwJYyZFXBCqMm0SjueRPr98yDO5E3C8Z7tNmSsjWK0vxGHu4?=
 =?us-ascii?Q?wGemFg6F1gZ55ftSY77NcMXcPVYTwPr6RVLkwtVtwzrDuRuEXkwLgn4V5uxx?=
 =?us-ascii?Q?MaQHhdZO/MBmPLPg2IJaddTuJTyuJH8n0xtEDq+4I19CehUU4h4wvf7l6Xka?=
 =?us-ascii?Q?muxzV3DhCDAwuLvkf7NliTdMsdRCLINx8rb5agIZ?=
X-MS-Exchange-CrossTenant-Network-Message-Id: ee29c754-7965-4f12-bdbd-08db15f28da0
X-MS-Exchange-CrossTenant-AuthSource: MW4PR11MB6739.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Feb 2023 23:06:10.9041
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 03OkvFa3MEDc76B+bKIvkQklod54Vo7OYuX1PubL0HW81ca5ibmKxzn8nuc8YJxtwQ6Di6Wyww6HsjJwSTDn6Q==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV2PR11MB6069
X-OriginatorOrg: intel.com
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Yang Li wrote:
> Make the description of @nvdimm to @ndd in function
> nvdimm_init_nsarea() and nvdimm_allocated_dpa () to silence the warnings:
> drivers/nvdimm/dimm_devs.c:59: warning: Function parameter or member 'ndd' not described in 'nvdimm_init_nsarea'
> drivers/nvdimm/dimm_devs.c:59: warning: Excess function parameter 'nvdimm' description in 'nvdimm_init_nsarea'
> drivers/nvdimm/dimm_devs.c:844: warning: Function parameter or member 'ndd' not described in 'nvdimm_allocated_dpa'
> drivers/nvdimm/dimm_devs.c:844: warning: Excess function parameter 'nvdimm' description in 'nvdimm_allocated_dpa
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
 Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4118

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

> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  drivers/nvdimm/dimm_devs.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/nvdimm/dimm_devs.c b/drivers/nvdimm/dimm_devs.c
> index 957f7c3d17ba..fc152e6016ca 100644
> --- a/drivers/nvdimm/dimm_devs.c
> +++ b/drivers/nvdimm/dimm_devs.c
> @@ -53,7 +53,7 @@ static int validate_dimm(struct nvdimm_drvdata *ndd)
>  
>  /**
>   * nvdimm_init_nsarea - determine the geometry of a dimm's namespace area
> - * @nvdimm: dimm to initialize
> + * @ndd: dimm to initialize
>   */
>  int nvdimm_init_nsarea(struct nvdimm_drvdata *ndd)
>  {
> @@ -836,7 +836,7 @@ struct resource *nvdimm_allocate_dpa(struct nvdimm_drvdata *ndd,
>  
>  /**
>   * nvdimm_allocated_dpa - sum up the dpa currently allocated to this label_id
> - * @nvdimm: container of dpa-resource-root + labels
> + * @ndd: container of dpa-resource-root + labels
>   * @label_id: dpa resource name of the form pmem-<human readable uuid>
>   */
>  resource_size_t nvdimm_allocated_dpa(struct nvdimm_drvdata *ndd,
> -- 
> 2.20.1.7.g153144c
>