linux-rdma.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Bart Van Assche <bvanassche@acm.org>,
	rd.dunlab@gmail.com, linux-rdma@vger.kernel.org
Cc: Doug Ledford <dledford@redhat.com>,
	Jason Gunthorpe <jgg@mellanox.com>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation
Date: Wed, 23 Oct 2019 13:39:08 -0700	[thread overview]
Message-ID: <41f6a96d-2913-b921-3d2c-219fe55dd22c@infradead.org> (raw)
In-Reply-To: <879db40b-1d88-d4ab-082e-b8535cb44cd4@acm.org>

On 10/23/19 1:30 PM, Bart Van Assche wrote:
> On 2019-10-09 20:52, rd.dunlab@gmail.com wrote:
>> --- linux-next-20191009.orig/drivers/infiniband/ulp/srpt/ib_srpt.h
>> +++ linux-next-20191009/drivers/infiniband/ulp/srpt/ib_srpt.h
>> @@ -387,12 +387,9 @@ struct srpt_port_id {
>>   * @sm_lid:    cached value of the port's sm_lid.
>>   * @lid:       cached value of the port's lid.
>>   * @gid:       cached value of the port's gid.
>> - * @port_acl_lock spinlock for port_acl_list:
>>   * @work:      work structure for refreshing the aforementioned cached values.
>> - * @port_guid_tpg: TPG associated with target port GUID.
>> - * @port_guid_wwn: WWN associated with target port GUID.
>> - * @port_gid_tpg:  TPG associated with target port GID.
>> - * @port_gid_wwn:  WWN associated with target port GID.
>> + * @port_guid_id: target port GUID
>> + * @port_gid_id: target port GID
>>   * @port_attrib:   Port attributes that can be accessed through configfs.
>>   * @refcount:	   Number of objects associated with this port.
>>   * @freed_channels: Completion that will be signaled once @refcount becomes 0.
> 
> This is sufficient to silence the warnings reported by the kernel-doc
> tool but I don't think that the new descriptions make really clear what
> these structure members represent. Do you want to address this or do you
> expect me to post a follow-up patch?

Hi Bart,

Since you know what the descriptions should say, I would appreciate it if you
would post a follow-up patch.

Thanks.
-- 
~Randy


  reply	other threads:[~2019-10-23 20:39 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-10  3:52 [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter rd.dunlab
2019-10-10  3:52 ` [PATCH 01/12] infiniband: fix ulp/iser/iscsi_iser.[hc] kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 02/12] infiniband: fix core/ipwm_util.h kernel-doc warnings rd.dunlab
2019-10-10  3:52 ` [PATCH 03/12] infiniband: fix ulp/iser/iscsi_iser.h " rd.dunlab
2019-10-10  3:52 ` [PATCH 04/12] infiniband: fix ulp/opa_vnic/opa_vnic_internal.h kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h " rd.dunlab
2019-10-22 17:52   ` Jason Gunthorpe
2019-10-22 19:51     ` Randy Dunlap
2019-10-23  7:26       ` Jani Nikula
2019-10-23 12:03       ` Dennis Dalessandro
2019-10-10  3:52 ` [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h " rd.dunlab
2019-10-23 20:30   ` Bart Van Assche
2019-10-23 20:39     ` Randy Dunlap [this message]
2019-10-10  3:52 ` [PATCH 07/12] infiniband: fix core/verbs.c " rd.dunlab
2019-10-10  3:52 ` [PATCH 08/12] infiniband: fix ulp/iser/iser_verbs.c " rd.dunlab
2019-10-10  3:52 ` [PATCH 09/12] infiniband: fix ulp/iser/iser_initiator.c kernel-doc warnings rd.dunlab
2019-10-10  3:52 ` [PATCH 10/12] infiniband: fix core/ kernel-doc notation rd.dunlab
2019-10-10  3:52 ` [PATCH 11/12] infiniband: fix sw/rdmavt/ " rd.dunlab
2019-10-10  3:52 ` [PATCH 12/12] infiniband: add a Documentation driver-api chapter for Infiniband rd.dunlab
2019-10-10 15:45   ` kbuild test robot
2019-10-21 17:07     ` Jason Gunthorpe
2019-10-21 21:57       ` Randy Dunlap
2019-10-22 18:41 ` [PATCH 00/12] infiniband kernel-doc fixes & driver-api/ chapter Jason Gunthorpe
2019-10-22 22:51   ` Max Gurtovoy
2019-10-23 11:54   ` Dennis Dalessandro
2019-10-23 14:39     ` 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=41f6a96d-2913-b921-3d2c-219fe55dd22c@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=bvanassche@acm.org \
    --cc=dledford@redhat.com \
    --cc=jgg@mellanox.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-rdma@vger.kernel.org \
    --cc=rd.dunlab@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 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).