| Message ID | 20231207210545.24056-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 0aec32ec57a3c31b0fd5e65ce82754c417032465 |
| Delegated to: | Ira Weiny |
| Headers | show |
| Series | [1/3] nvdimm/btt: fix btt_blk_cleanup() kernel-doc | expand |
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 <rdunlap@infradead.org> > Cc: Vishal Verma <vishal.l.verma@intel.com> > Cc: Dan Williams <dan.j.williams@intel.com> > Cc: Dave Jiang <dave.jiang@intel.com> > Cc: Ira Weiny <ira.weiny@intel.com> Reviewed-by: Ira Weiny <ira.weiny@intel.com> > Cc: nvdimm@lists.linux.dev > --- > 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.
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.
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 <rdunlap@infradead.org> Cc: Vishal Verma <vishal.l.verma@intel.com> Cc: Dan Williams <dan.j.williams@intel.com> Cc: Dave Jiang <dave.jiang@intel.com> Cc: Ira Weiny <ira.weiny@intel.com> Cc: nvdimm@lists.linux.dev --- drivers/nvdimm/btt.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)