All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jason Gunthorpe <jgg@nvidia.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Doug Ledford <dledford@redhat.com>,
	Leon Romanovsky <leon@kernel.org>,
	linux-rdma@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
	Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH] RDMA/restrack: update kernel documentation for ib_create_named_qp()
Date: Thu, 10 Dec 2020 17:29:41 +0000	[thread overview]
Message-ID: <20201210172941.GC2117013@nvidia.com> (raw)
In-Reply-To: <20201207173255.13355-1-lukas.bulwahn@gmail.com>

On Mon, Dec 07, 2020 at 06:32:55PM +0100, Lukas Bulwahn wrote:
> Commit 66f57b871efc ("RDMA/restrack: Support all QP types") extends
> ib_create_qp() to a named ib_create_named_qp(), which takes the caller's
> name as argument, but it did not add the new argument description to the
> function's kerneldoc.
> 
> make htmldocs warns:
> 
>   ./drivers/infiniband/core/verbs.c:1206: warning: Function parameter or
>   member 'caller' not described in 'ib_create_named_qp'
> 
> Add a description for this new argument based on the description of the
> same argument in other related functions.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> Reviewed-by: Leon Romanovsky <leonro@nvidia.com>
> ---
>  drivers/infiniband/core/verbs.c | 1 +
>  1 file changed, 1 insertion(+)

Applies to for-next, thanks

Jason

WARNING: multiple messages have this Message-ID (diff)
From: Jason Gunthorpe <jgg@nvidia.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Doug Ledford <dledford@redhat.com>,
	Leon Romanovsky <leon@kernel.org>, <linux-rdma@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<kernel-janitors@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH] RDMA/restrack: update kernel documentation for ib_create_named_qp()
Date: Thu, 10 Dec 2020 13:29:41 -0400	[thread overview]
Message-ID: <20201210172941.GC2117013@nvidia.com> (raw)
In-Reply-To: <20201207173255.13355-1-lukas.bulwahn@gmail.com>

On Mon, Dec 07, 2020 at 06:32:55PM +0100, Lukas Bulwahn wrote:
> Commit 66f57b871efc ("RDMA/restrack: Support all QP types") extends
> ib_create_qp() to a named ib_create_named_qp(), which takes the caller's
> name as argument, but it did not add the new argument description to the
> function's kerneldoc.
> 
> make htmldocs warns:
> 
>   ./drivers/infiniband/core/verbs.c:1206: warning: Function parameter or
>   member 'caller' not described in 'ib_create_named_qp'
> 
> Add a description for this new argument based on the description of the
> same argument in other related functions.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> Reviewed-by: Leon Romanovsky <leonro@nvidia.com>
> ---
>  drivers/infiniband/core/verbs.c | 1 +
>  1 file changed, 1 insertion(+)

Applies to for-next, thanks

Jason

  parent reply	other threads:[~2020-12-10 17:29 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-07 17:32 [PATCH] RDMA/restrack: update kernel documentation for ib_create_named_qp() Lukas Bulwahn
2020-12-07 17:32 ` Lukas Bulwahn
2020-12-08  6:44 ` Leon Romanovsky
2020-12-08  6:44   ` Leon Romanovsky
2020-12-10 17:29 ` Jason Gunthorpe [this message]
2020-12-10 17:29   ` 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=20201210172941.GC2117013@nvidia.com \
    --to=jgg@nvidia.com \
    --cc=corbet@lwn.net \
    --cc=dledford@redhat.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=leon@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-rdma@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.