* [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation
@ 2020-08-20 12:35 Kamal Heib
2020-08-21 17:43 ` Adit Ranadive
2020-08-24 17:37 ` Jason Gunthorpe
0 siblings, 2 replies; 3+ messages in thread
From: Kamal Heib @ 2020-08-20 12:35 UTC (permalink / raw)
To: linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe, Adit Ranadive, Kamal Heib
Fix the kernel-doc documentation by matching between the functions
definitions and documentation.
Signed-off-by: Kamal Heib <kamalheib1@gmail.com>
---
drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c | 2 +-
drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c | 1 +
drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c | 2 +-
drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c | 7 +++----
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
index 4f6cc0de7ef9..01cd122a8b69 100644
--- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
+++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
@@ -375,7 +375,7 @@ static int pvrdma_poll_one(struct pvrdma_cq *cq, struct pvrdma_qp **cur_qp,
* 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
*/
diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
index 77a010e68208..91f0957e6115 100644
--- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
+++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
@@ -270,6 +270,7 @@ struct ib_mr *pvrdma_alloc_mr(struct ib_pd *pd, enum ib_mr_type mr_type,
/**
* pvrdma_dereg_mr - deregister a memory region
* @ibmr: memory region
+ * @udata: pointer to user data
*
* @return: 0 on success.
*/
diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
index d330decfb80a..f60a8e81bddd 100644
--- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
+++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
@@ -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
*
diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
index ccbded2d26ce..65ac3693ad12 100644
--- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
+++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
@@ -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.
*/
--
2.26.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation
2020-08-20 12:35 [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation Kamal Heib
@ 2020-08-21 17:43 ` Adit Ranadive
2020-08-24 17:37 ` Jason Gunthorpe
1 sibling, 0 replies; 3+ messages in thread
From: Adit Ranadive @ 2020-08-21 17:43 UTC (permalink / raw)
To: Kamal Heib, linux-rdma; +Cc: Doug Ledford, Jason Gunthorpe
On 8/20/20 5:35 AM, Kamal Heib wrote:
> Fix the kernel-doc documentation by matching between the functions
> definitions and documentation.
>
> Signed-off-by: Kamal Heib <kamalheib1@gmail.com>
> ---
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c | 2 +-
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c | 1 +
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c | 2 +-
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c | 7 +++----
> 4 files changed, 6 insertions(+), 6 deletions(-)
>
Thanks!
Acked-by: Adit Ranadive <aditr@vmware.com>
> diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
> index 4f6cc0de7ef9..01cd122a8b69 100644
> --- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
> +++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c
> @@ -375,7 +375,7 @@ static int pvrdma_poll_one(struct pvrdma_cq *cq, struct pvrdma_qp **cur_qp,
> * 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
> */
> diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
> index 77a010e68208..91f0957e6115 100644
> --- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
> +++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c
> @@ -270,6 +270,7 @@ struct ib_mr *pvrdma_alloc_mr(struct ib_pd *pd, enum ib_mr_type mr_type,
> /**
> * pvrdma_dereg_mr - deregister a memory region
> * @ibmr: memory region
> + * @udata: pointer to user data
> *
> * @return: 0 on success.
> */
> diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
> index d330decfb80a..f60a8e81bddd 100644
> --- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
> +++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c
> @@ -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
> *
> diff --git a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
> index ccbded2d26ce..65ac3693ad12 100644
> --- a/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
> +++ b/drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c
> @@ -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.
> */
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation
2020-08-20 12:35 [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation Kamal Heib
2020-08-21 17:43 ` Adit Ranadive
@ 2020-08-24 17:37 ` Jason Gunthorpe
1 sibling, 0 replies; 3+ messages in thread
From: Jason Gunthorpe @ 2020-08-24 17:37 UTC (permalink / raw)
To: Kamal Heib; +Cc: linux-rdma, Doug Ledford, Adit Ranadive
On Thu, Aug 20, 2020 at 03:35:12PM +0300, Kamal Heib wrote:
> Fix the kernel-doc documentation by matching between the functions
> definitions and documentation.
>
> Signed-off-by: Kamal Heib <kamalheib1@gmail.com>
> Acked-by: Adit Ranadive <aditr@vmware.com>
> ---
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_cq.c | 2 +-
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_mr.c | 1 +
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_srq.c | 2 +-
> drivers/infiniband/hw/vmw_pvrdma/pvrdma_verbs.c | 7 +++----
> 4 files changed, 6 insertions(+), 6 deletions(-)
Applied to for-next, thanks
Jason
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-08-24 17:38 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-20 12:35 [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation Kamal Heib
2020-08-21 17:43 ` Adit Ranadive
2020-08-24 17:37 ` Jason Gunthorpe
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).