[-next] RDMA/irdma: Fix one kernel-doc comment

Message ID 20230731015915.34867-1-yang.lee@linux.alibaba.com
State New
Headers
Series [-next] RDMA/irdma: Fix one kernel-doc comment |

Commit Message

Yang Li July 31, 2023, 1:59 a.m. UTC
  Remove description of @free_hwcqp in irdma_destroy_cqp().
to silence the warning:

drivers/infiniband/hw/irdma/hw.c:580: warning: Excess function parameter 'free_hwcqp' description in 'irdma_destroy_cqp'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=6028
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/infiniband/hw/irdma/hw.c | 1 -
 1 file changed, 1 deletion(-)
  

Comments

Randy Dunlap July 31, 2023, 2:18 a.m. UTC | #1
On 7/30/23 18:59, Yang Li wrote:
> Remove description of @free_hwcqp in irdma_destroy_cqp().
> to silence the warning:
> 
> drivers/infiniband/hw/irdma/hw.c:580: warning: Excess function parameter 'free_hwcqp' description in 'irdma_destroy_cqp'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=6028
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/infiniband/hw/irdma/hw.c | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/infiniband/hw/irdma/hw.c b/drivers/infiniband/hw/irdma/hw.c
> index eaf196985f49..7cbdd5433dba 100644
> --- a/drivers/infiniband/hw/irdma/hw.c
> +++ b/drivers/infiniband/hw/irdma/hw.c
> @@ -571,7 +571,6 @@ static void irdma_destroy_irq(struct irdma_pci_f *rf,
>  /**
>   * irdma_destroy_cqp  - destroy control qp
>   * @rf: RDMA PCI function
> - * @free_hwcqp: 1 if hw cqp should be freed
>   *
>   * Issue destroy cqp request and
>   * free the resources associated with the cqp
  
Leon Romanovsky July 31, 2023, 7:41 a.m. UTC | #2
On Mon, 31 Jul 2023 09:59:15 +0800, Yang Li wrote:
> Remove description of @free_hwcqp in irdma_destroy_cqp().
> to silence the warning:
> 
> drivers/infiniband/hw/irdma/hw.c:580: warning: Excess function parameter 'free_hwcqp' description in 'irdma_destroy_cqp'
> 
> 

Applied, thanks!

[1/1] RDMA/irdma: Fix one kernel-doc comment
      https://git.kernel.org/rdma/rdma/c/d43ea9c3d52f2e

Best regards,
  

Patch

diff --git a/drivers/infiniband/hw/irdma/hw.c b/drivers/infiniband/hw/irdma/hw.c
index eaf196985f49..7cbdd5433dba 100644
--- a/drivers/infiniband/hw/irdma/hw.c
+++ b/drivers/infiniband/hw/irdma/hw.c
@@ -571,7 +571,6 @@  static void irdma_destroy_irq(struct irdma_pci_f *rf,
 /**
  * irdma_destroy_cqp  - destroy control qp
  * @rf: RDMA PCI function
- * @free_hwcqp: 1 if hw cqp should be freed
  *
  * Issue destroy cqp request and
  * free the resources associated with the cqp