| Message ID | 20230220071256.72513-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [-next] libnvdimm: Fix some kernel-doc comments | expand |
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 >
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,
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 Signed-off-by: Yang Li <yang.lee@linux.alibaba.com> --- drivers/nvdimm/dimm_devs.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)