Re: [PATCH 05/12] infiniband: fix ulp/opa_vnic/opa_vnic_encap.h kernel-doc notation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 10/22/2019 3:51 PM, Randy Dunlap wrote:
On 10/22/19 10:52 AM, Jason Gunthorpe wrote:
On Wed, Oct 09, 2019 at 08:52:44PM -0700, rd.dunlab@xxxxxxxxx wrote:
Make reserved struct fields "private:" so that they don't need to
be added to the kernel-doc notation. This removes 24 warnings.

+++ linux-next-20191009/drivers/infiniband/ulp/opa_vnic/opa_vnic_encap.h
@@ -129,21 +129,31 @@ struct opa_vesw_info {
  	__be16  fabric_id;
  	__be16  vesw_id;
+ /* private: */
  	u8      rsvd0[6];
+	/* public: */
  	__be16  def_port_mask;

This seems overly ugly, is there some other way to handle these
reserved fields? Maybe wire protocol structures shouldn't be kdoc?

I don't know of any other way to handle them with kernel-doc.
Sure, changing the /** to just /* would be one way to hide the
warnings.  Either this patch or not having them be kernel-doc
is needed just to "fix" 24 warnings.


I would be in favor of just not including this in kernel-doc at this time, but the mess of private/public tags while hard on the eyes doesn't really bother me either.

Also wouldn't take this as a statement that wire protocol structures not be in kdoc, but just that this one doesn't need to be there.

-Denny



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux