Re: [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation

From: Bart Van Assche <bvanassche@acm.org>
To: 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, Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH 06/12] infiniband: fix ulp/srpt/ib_srpt.h kernel-doc notation
Date: Wed, 23 Oct 2019 13:30:38 -0700	[thread overview]
Message-ID: <879db40b-1d88-d4ab-082e-b8535cb44cd4@acm.org> (raw)
In-Reply-To: <20191010035239.950150496@gmail.com>

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?

Thanks,

Bart.