diff mbox series

[03/30] RDMA/hw/efa/efa_com: Stop using param description notation for non-params

Message ID 20210121094519.2044049-4-lee.jones@linaro.org (mailing list archive)
State Superseded
Delegated to: Jason Gunthorpe
Headers show
Series Rid W=1 warnings from Infiniband | expand

Commit Message

Lee Jones Jan. 21, 2021, 9:44 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/infiniband/hw/efa/efa_com.c:801: warning: Excess function parameter 'note' description in 'efa_com_admin_q_comp_intr_handler'

Cc: Gal Pressman <galpress@amazon.com>
Cc: Yossi Leybovich <sleybo@amazon.com>
Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/infiniband/hw/efa/efa_com.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Gal Pressman Jan. 21, 2021, 1:14 p.m. UTC | #1
On 21/01/2021 11:44, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/infiniband/hw/efa/efa_com.c:801: warning: Excess function parameter 'note' description in 'efa_com_admin_q_comp_intr_handler'
> 
> Cc: Gal Pressman <galpress@amazon.com>
> Cc: Yossi Leybovich <sleybo@amazon.com>
> Cc: Doug Ledford <dledford@redhat.com>
> Cc: Jason Gunthorpe <jgg@ziepe.ca>
> Cc: linux-rdma@vger.kernel.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>

I would change the subject's prefix to 'RDMA/efa', but other than that looks good:
Acked-by: Gal Pressman <galpress@amazon.com>

Thanks Lee.
diff mbox series

Patch

diff --git a/drivers/infiniband/hw/efa/efa_com.c b/drivers/infiniband/hw/efa/efa_com.c
index 336bc2c57bb1d..f7242188a8434 100644
--- a/drivers/infiniband/hw/efa/efa_com.c
+++ b/drivers/infiniband/hw/efa/efa_com.c
@@ -795,7 +795,7 @@  int efa_com_admin_init(struct efa_com_dev *edev,
  * This method goes over the admin completion queue and wakes up
  * all the pending threads that wait on the commands wait event.
  *
- * @note: Should be called after MSI-X interrupt.
+ * Note: Should be called after MSI-X interrupt.
  */
 void efa_com_admin_q_comp_intr_handler(struct efa_com_dev *edev)
 {