From: Bart Van Assche <bvanassche@acm.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Doug Ledford <dledford@redhat.com>,
Jason Gunthorpe <jgg@ziepe.ca>, Max Gurtovoy <maxg@mellanox.com>,
Sagi Grimberg <sagi@grimberg.me>,
Yamin Friedman <yaminf@mellanox.com>,
linux-kernel@vger.kernel.org, linux-rdma@vger.kernel.org,
target-devel@vger.kernel.org
Subject: Re: [PATCH v3 4/6] IB/srpt: docs: add a description for cq_size member
Date: Wed, 21 Oct 2020 17:25:44 -0700 [thread overview]
Message-ID: <cb5944e2-bdea-e320-d4d1-2f9bc9539a19@acm.org> (raw)
In-Reply-To: <32f4060a4300c20894b38f2504ee76ccfa497215.1603282193.git.mchehab+huawei@kernel.org>
On 10/21/20 5:17 AM, Mauro Carvalho Chehab wrote:
> Changeset c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")
> added a new member for struct srpt_rdma_ch, but didn't add the
> corresponding kernel-doc markup, as repoted when doing
> "make htmldocs":
>
> ./drivers/infiniband/ulp/srpt/ib_srpt.h:331: warning: Function parameter or member 'cq_size' not described in 'srpt_rdma_ch'
>
> Add a description for it.
>
> Fixes: c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> drivers/infiniband/ulp/srpt/ib_srpt.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/infiniband/ulp/srpt/ib_srpt.h b/drivers/infiniband/ulp/srpt/ib_srpt.h
> index 41435a699b53..bdeb010efee6 100644
> --- a/drivers/infiniband/ulp/srpt/ib_srpt.h
> +++ b/drivers/infiniband/ulp/srpt/ib_srpt.h
> @@ -256,6 +256,7 @@ enum rdma_ch_state {
> * @rdma_cm: See below.
> * @rdma_cm.cm_id: RDMA CM ID associated with the channel.
> * @cq: IB completion queue for this channel.
> + * @cq_size: Number of CQEs in @cq.
> * @zw_cqe: Zero-length write CQE.
> * @rcu: RCU head.
> * @kref: kref for this channel.
Reviewed-by: Bart Van Assche <bvanassche@acm.org>
WARNING: multiple messages have this Message-ID (diff)
From: Bart Van Assche <bvanassche@acm.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Doug Ledford <dledford@redhat.com>,
Jason Gunthorpe <jgg@ziepe.ca>, Max Gurtovoy <maxg@mellanox.com>,
Sagi Grimberg <sagi@grimberg.me>,
Yamin Friedman <yaminf@mellanox.com>,
linux-kernel@vger.kernel.org, linux-rdma@vger.kernel.org,
target-devel@vger.kernel.org
Subject: Re: [PATCH v3 4/6] IB/srpt: docs: add a description for cq_size member
Date: Thu, 22 Oct 2020 00:25:44 +0000 [thread overview]
Message-ID: <cb5944e2-bdea-e320-d4d1-2f9bc9539a19@acm.org> (raw)
In-Reply-To: <32f4060a4300c20894b38f2504ee76ccfa497215.1603282193.git.mchehab+huawei@kernel.org>
On 10/21/20 5:17 AM, Mauro Carvalho Chehab wrote:
> Changeset c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")
> added a new member for struct srpt_rdma_ch, but didn't add the
> corresponding kernel-doc markup, as repoted when doing
> "make htmldocs":
>
> ./drivers/infiniband/ulp/srpt/ib_srpt.h:331: warning: Function parameter or member 'cq_size' not described in 'srpt_rdma_ch'
>
> Add a description for it.
>
> Fixes: c804af2c1d31 ("IB/srpt: use new shared CQ mechanism")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> drivers/infiniband/ulp/srpt/ib_srpt.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/infiniband/ulp/srpt/ib_srpt.h b/drivers/infiniband/ulp/srpt/ib_srpt.h
> index 41435a699b53..bdeb010efee6 100644
> --- a/drivers/infiniband/ulp/srpt/ib_srpt.h
> +++ b/drivers/infiniband/ulp/srpt/ib_srpt.h
> @@ -256,6 +256,7 @@ enum rdma_ch_state {
> * @rdma_cm: See below.
> * @rdma_cm.cm_id: RDMA CM ID associated with the channel.
> * @cq: IB completion queue for this channel.
> + * @cq_size: Number of CQEs in @cq.
> * @zw_cqe: Zero-length write CQE.
> * @rcu: RCU head.
> * @kref: kref for this channel.
Reviewed-by: Bart Van Assche <bvanassche@acm.org>
next prev parent reply other threads:[~2020-10-22 0:25 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-21 12:17 [PATCH v3 0/6] Documentation build fixes against upstream Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-21 12:17 ` [PATCH v3 1/6] drm: amdgpu: kernel-doc: update some adev parameters Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-21 18:37 ` Alex Deucher
2020-10-21 18:37 ` Alex Deucher
2020-10-21 18:37 ` Alex Deucher
2020-10-21 12:17 ` [PATCH v3 2/6] docs: lockdep-design: fix some warning issues Mauro Carvalho Chehab
2020-10-21 3:27 ` Boqun Feng
2020-10-21 12:17 ` [PATCH v3 3/6] locking/refcount: move kernel-doc markups to the proper place Mauro Carvalho Chehab
2020-10-21 12:17 ` [PATCH v3 4/6] IB/srpt: docs: add a description for cq_size member Mauro Carvalho Chehab
2020-10-21 12:17 ` Mauro Carvalho Chehab
2020-10-22 0:25 ` Bart Van Assche [this message]
2020-10-22 0:25 ` Bart Van Assche
2020-10-21 12:17 ` [PATCH v3 5/6] kunit: test: fix remaining kernel-doc warnings Mauro Carvalho Chehab
2020-10-21 21:12 ` Brendan Higgins
2020-10-26 19:29 ` Shuah Khan
2020-10-21 12:17 ` [PATCH v3 6/6] docs: fs: api-summary.rst: get rid of kernel-doc include Mauro Carvalho Chehab
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=cb5944e2-bdea-e320-d4d1-2f9bc9539a19@acm.org \
--to=bvanassche@acm.org \
--cc=corbet@lwn.net \
--cc=dledford@redhat.com \
--cc=jgg@ziepe.ca \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rdma@vger.kernel.org \
--cc=maxg@mellanox.com \
--cc=mchehab+huawei@kernel.org \
--cc=sagi@grimberg.me \
--cc=target-devel@vger.kernel.org \
--cc=yaminf@mellanox.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.