RDMA/vmw_pvrdma: Fix kernel-doc documentation
authorKamal Heib <kamalheib1@gmail.com>
Thu, 20 Aug 2020 12:35:12 +0000 (15:35 +0300)
committerJason Gunthorpe <jgg@nvidia.com>
Mon, 24 Aug 2020 17:34:18 +0000 (14:34 -0300)
Fix the kernel-doc documentation by matching between the functions
definitions and documentation.

Link: https://lore.kernel.org/r/20200820123512.105193-1-kamalheib1@gmail.com
Signed-off-by: Kamal Heib <kamalheib1@gmail.com>
Acked-by: Adit Ranadive <aditr@vmware.com>
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c

index 4f6cc0de7ef95760d8faf4a6d1f7b7f5a40a97e5..01cd122a8b692fa5fa55fb0e1e5c930d371b3043 100644 (file)
@@ -375,7 +375,7 @@ retry:
  * pvrdma_poll_cq - poll for work completion queue entries
  * @ibcq: completion queue
  * @num_entries: the maximum number of entries
- * @entry: pointer to work completion array
+ * @wc: pointer to work completion array
  *
  * @return: number of polled completion entries
  */
index 77a010e682081aa7e61c4b9f3da5a266e803a3ba..91f0957e6115434014c9288fb2cab676f2bcc0ae 100644 (file)
@@ -270,6 +270,7 @@ freemr:
 /**
  * pvrdma_dereg_mr - deregister a memory region
  * @ibmr: memory region
+ * @udata: pointer to user data
  *
  * @return: 0 on success.
  */
index d330decfb80a2434babae97c526889ac6fd24f84..f60a8e81bddddb87738817ade3b054f28e2089be 100644 (file)
@@ -90,7 +90,7 @@ int pvrdma_query_srq(struct ib_srq *ibsrq, struct ib_srq_attr *srq_attr)
 
 /**
  * pvrdma_create_srq - create shared receive queue
- * @pd: protection domain
+ * @ibsrq: the IB shared receive queue
  * @init_attr: shared receive queue attributes
  * @udata: user data
  *
index ccbded2d26ce8efa434f6fb6f789fcd75da66639..65ac3693ad120b1b8f88bcdf4f3877fb2d92ba57 100644 (file)
@@ -502,10 +502,9 @@ void pvrdma_dealloc_pd(struct ib_pd *pd, struct ib_udata *udata)
 
 /**
  * pvrdma_create_ah - create an address handle
- * @pd: the protection domain
- * @ah_attr: the attributes of the AH
- * @udata: user data blob
- * @flags: create address handle flags (see enum rdma_create_ah_flags)
+ * @ibah: the IB address handle
+ * @init_attr: the attributes of the AH
+ * @udata: pointer to user data
  *
  * @return: 0 on success, otherwise errno.
  */