| Message ID | 20220404050041.594774-1-damien.lemoal@opensource.wdc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Headers | show |
| Series | scsi: mpt3sas: Fix mpt3sas_check_same_4gb_region() kdoc comment | expand |
On Mon, Apr 4, 2022 at 10:30 AM 'Damien Le Moal' via PDL-MPT-FUSIONLINUX <mpt-fusionlinux.pdl@broadcom.com> wrote: > > The start_addres argument of mpt3sas_check_same_4gb_region() was > misnamed in the function kdoc comment, resulting in the following > warning when compiling with W=1. > > drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Function parameter or > member 'start_address' not described in 'mpt3sas_check_same_4gb_region' > drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Excess function > parameter 'reply_pool_start_address' description in > 'mpt3sas_check_same_4gb_region' > > Fix the argument name in the function kdoc comment to avoid it. While at > it, remove a useless blank line between the kdoc and function code. Thanks for the patch. Ack-by: Sreekanth Reddy <sreekanth.reddy@broadcom.com> > > Signed-off-by: Damien Le Moal <damien.lemoal@opensource.wdc.com> > --- > drivers/scsi/mpt3sas/mpt3sas_base.c | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/drivers/scsi/mpt3sas/mpt3sas_base.c b/drivers/scsi/mpt3sas/mpt3sas_base.c > index b57f1803371e..538d2c0cd971 100644 > --- a/drivers/scsi/mpt3sas/mpt3sas_base.c > +++ b/drivers/scsi/mpt3sas/mpt3sas_base.c > @@ -5716,13 +5716,12 @@ _base_release_memory_pools(struct MPT3SAS_ADAPTER *ioc) > /** > * mpt3sas_check_same_4gb_region - checks whether all reply queues in a set are > * having same upper 32bits in their base memory address. > - * @reply_pool_start_address: Base address of a reply queue set > + * @start_address: Base address of a reply queue set > * @pool_sz: Size of single Reply Descriptor Post Queues pool size > * > * Return: 1 if reply queues in a set have a same upper 32bits in their base > * memory address, else 0. > */ > - > static int > mpt3sas_check_same_4gb_region(dma_addr_t start_address, u32 pool_sz) > { > -- > 2.35.1 >
diff --git a/drivers/scsi/mpt3sas/mpt3sas_base.c b/drivers/scsi/mpt3sas/mpt3sas_base.c index b57f1803371e..538d2c0cd971 100644 --- a/drivers/scsi/mpt3sas/mpt3sas_base.c +++ b/drivers/scsi/mpt3sas/mpt3sas_base.c @@ -5716,13 +5716,12 @@ _base_release_memory_pools(struct MPT3SAS_ADAPTER *ioc) /** * mpt3sas_check_same_4gb_region - checks whether all reply queues in a set are * having same upper 32bits in their base memory address. - * @reply_pool_start_address: Base address of a reply queue set + * @start_address: Base address of a reply queue set * @pool_sz: Size of single Reply Descriptor Post Queues pool size * * Return: 1 if reply queues in a set have a same upper 32bits in their base * memory address, else 0. */ - static int mpt3sas_check_same_4gb_region(dma_addr_t start_address, u32 pool_sz) {
The start_addres argument of mpt3sas_check_same_4gb_region() was misnamed in the function kdoc comment, resulting in the following warning when compiling with W=1. drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Function parameter or member 'start_address' not described in 'mpt3sas_check_same_4gb_region' drivers/scsi/mpt3sas/mpt3sas_base.c:5728: warning: Excess function parameter 'reply_pool_start_address' description in 'mpt3sas_check_same_4gb_region' Fix the argument name in the function kdoc comment to avoid it. While at it, remove a useless blank line between the kdoc and function code. Signed-off-by: Damien Le Moal <damien.lemoal@opensource.wdc.com> --- drivers/scsi/mpt3sas/mpt3sas_base.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)