[PATCH] RDMA/cm: correct typedef and bad line warnings

[PATCH] RDMA/cm: correct typedef and bad line warnings

[Randy Dunlap]

In include/rdma/ib_cm.h:

Correct a typedef's kernel-doc notation by adding the 'typedef' keyword
to it to avoid a warning.
Add a leading " *" to a kernel-doc line to avoid a warning.

Warning: ib_cm.h:289 function parameter 'ib_cm_handler' not described
 in 'int'
Warning: ib_cm.h:289 expecting prototype for ib_cm_handler().  Prototype
 was for int() instead
Warning: ib_cm.h:484 bad line: connection message in case duplicates
 are received.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jason Gunthorpe <jgg@nvidia.com>
Cc: Leon Romanovsky <leonro@nvidia.com>
Cc: linux-rdma@vger.kernel.org
---
 include/rdma/ib_cm.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20251110.orig/include/rdma/ib_cm.h
+++ linux-next-20251110/include/rdma/ib_cm.h
@@ -271,7 +271,7 @@ struct ib_cm_event {
 #define CM_APR_ATTR_ID		cpu_to_be16(0x001A)
 
 /**
- * ib_cm_handler - User-defined callback to process communication events.
+ * typedef ib_cm_handler - User-defined callback to process communication events.
  * @cm_id: Communication identifier associated with the reported event.
  * @event: Information about the communication event.
  *
@@ -482,7 +482,7 @@ int ib_send_cm_rej(struct ib_cm_id *cm_i
 
 /**
  * ib_prepare_cm_mra - Prepares to send a message receipt acknowledgment to a
-     connection message in case duplicates are received.
+ *   connection message in case duplicates are received.
  * @cm_id: Connection identifier associated with the connection message.
  */
 int ib_prepare_cm_mra(struct ib_cm_id *cm_id);

Re: [PATCH] RDMA/cm: correct typedef and bad line warnings

[Leon Romanovsky]

On Tue, Nov 11, 2025 at 10:29:08PM -0800, Randy Dunlap wrote:
> In include/rdma/ib_cm.h:
> 
> Correct a typedef's kernel-doc notation by adding the 'typedef' keyword
> to it to avoid a warning.
> Add a leading " *" to a kernel-doc line to avoid a warning.
> 
> Warning: ib_cm.h:289 function parameter 'ib_cm_handler' not described
>  in 'int'
> Warning: ib_cm.h:289 expecting prototype for ib_cm_handler().  Prototype
>  was for int() instead
> Warning: ib_cm.h:484 bad line: connection message in case duplicates
>  are received.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jason Gunthorpe <jgg@nvidia.com>
> Cc: Leon Romanovsky <leonro@nvidia.com>
> Cc: linux-rdma@vger.kernel.org
> ---
>  include/rdma/ib_cm.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Thanks, applied.

Re: [PATCH] RDMA/cm: correct typedef and bad line warnings

[Leon Romanovsky]

On Tue, 11 Nov 2025 22:29:08 -0800, Randy Dunlap wrote:
> In include/rdma/ib_cm.h:
> 
> Correct a typedef's kernel-doc notation by adding the 'typedef' keyword
> to it to avoid a warning.
> Add a leading " *" to a kernel-doc line to avoid a warning.
> 
> Warning: ib_cm.h:289 function parameter 'ib_cm_handler' not described
>  in 'int'
> Warning: ib_cm.h:289 expecting prototype for ib_cm_handler().  Prototype
>  was for int() instead
> Warning: ib_cm.h:484 bad line: connection message in case duplicates
>  are received.
> 
> [...]

Applied, thanks!

[1/1] RDMA/cm: correct typedef and bad line warnings
      https://git.kernel.org/rdma/rdma/c/64a5e132a82a02

Best regards,
-- 
Leon Romanovsky <leonro@nvidia.com>