linux-rdma.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Adit Ranadive <aditr@vmware.com>
To: Kamal Heib <kamalheib1@gmail.com>, linux-rdma@vger.kernel.org
Cc: Doug Ledford <dledford@redhat.com>, Jason Gunthorpe <jgg@ziepe.ca>
Subject: Re: [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation
Date: Fri, 21 Aug 2020 10:43:00 -0700	[thread overview]
Message-ID: <ac9d933c-47d7-100d-0ad1-3e87e9481105@vmware.com> (raw)
In-Reply-To: <20200820123512.105193-1-kamalheib1@gmail.com>

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.
>   */
> 


  reply	other threads:[~2020-08-21 17:43 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-20 12:35 [PATCH for-next] RDMA/vmw_pvrdma: Fix kernel-doc documentation Kamal Heib
2020-08-21 17:43 ` Adit Ranadive [this message]
2020-08-24 17:37 ` Jason Gunthorpe

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ac9d933c-47d7-100d-0ad1-3e87e9481105@vmware.com \
    --to=aditr@vmware.com \
    --cc=dledford@redhat.com \
    --cc=jgg@ziepe.ca \
    --cc=kamalheib1@gmail.com \
    --cc=linux-rdma@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
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).