Commit bf194997 authored by Leon Romanovsky's avatar Leon Romanovsky Committed by Jason Gunthorpe
Browse files

RDMA: Fix kernel-doc warnings about wrong comment 

Compilation with W=1 produces warnings similar to the below.

  drivers/infiniband/ulp/ipoib/ipoib_main.c:320: warning: This comment
	starts with '/**', but isn't a kernel-doc comment. Refer
	Documentation/doc-guide/kernel-doc.rst

All such occurrences were found with the following one line
 git grep -A 1 "\/\*\*" drivers/infiniband/

Link: https://lore.kernel.org/r/e57d5f4ddd08b7a19934635b44d6d632841b9ba7.1623823612.git.leonro@nvidia.com


Reviewed-by: Jack Wang <jinpu.wang@ionos.com> #rtrs
Reviewed-by: default avatarDennis Dalessandro <dennis.dalessandro@cornelisnetworks.com>
Signed-off-by: default avatarLeon Romanovsky <leonro@nvidia.com>
Signed-off-by: default avatarJason Gunthorpe <jgg@nvidia.com>
parent da43b7be

drivers/infiniband/core/iwpm_util.h

+1 −1
Original line number Diff line number Diff line
@@ -183,7 +183,7 @@ u32 iwpm_check_registration(u8 nl_client, u32 reg); 
void iwpm_set_registration(u8 nl_client, u32 reg);



/**

 * iwpm_get_registration

 * iwpm_get_registration - Get the client registration

 * @nl_client: The index of the netlink client

 *

 * Returns the client registration type

drivers/infiniband/core/roce_gid_mgmt.c

+3 −2
Original line number Diff line number Diff line
@@ -186,12 +186,13 @@ is_eth_port_inactive_slave_filter(struct ib_device *ib_dev, u32 port, 
	return res;

}



/** is_ndev_for_default_gid_filter - Check if a given netdevice

/**

 * is_ndev_for_default_gid_filter - Check if a given netdevice

 * can be considered for default GIDs or not.

 * @ib_dev:		IB device to check

 * @port:		Port to consider for adding default GID

 * @rdma_ndev:		rdma netdevice pointer

 * @cookie_ndev:	Netdevice to consider to form a default GID

 * @cookie:             Netdevice to consider to form a default GID

 *

 * is_ndev_for_default_gid_filter() returns true if a given netdevice can be

 * considered for deriving default RoCE GID, returns false otherwise.

drivers/infiniband/hw/hfi1/chip.c

+2 −2
Original line number Diff line number Diff line
@@ -14186,7 +14186,7 @@ static void init_kdeth_qp(struct hfi1_devdata *dd) 
}



/**

 * hfi1_get_qp_map

 * hfi1_get_qp_map - get qp map

 * @dd: device data

 * @idx: index to read

 */
@@ -14199,7 +14199,7 @@ u8 hfi1_get_qp_map(struct hfi1_devdata *dd, u8 idx) 
}



/**

 * init_qpmap_table

 * init_qpmap_table - init qp map

 * @dd: device data

 * @first_ctxt: first context

 * @last_ctxt: first context

drivers/infiniband/hw/hfi1/file_ops.c

+3 −3
Original line number Diff line number Diff line
@@ -736,7 +736,7 @@ static u64 kvirt_to_phys(void *addr) 
}



/**

 * complete_subctxt

 * complete_subctxt - complete sub-context info

 * @fd: valid filedata pointer

 *

 * Sub-context info can only be set up after the base context
@@ -841,7 +841,7 @@ static int assign_ctxt(struct hfi1_filedata *fd, unsigned long arg, u32 len) 
}



/**

 * match_ctxt

 * match_ctxt - match context

 * @fd: valid filedata pointer

 * @uinfo: user info to compare base context with

 * @uctxt: context to compare uinfo to.
@@ -898,7 +898,7 @@ static int match_ctxt(struct hfi1_filedata *fd, 
}



/**

 * find_sub_ctxt

 * find_sub_ctxt - fund sub-context

 * @fd: valid filedata pointer

 * @uinfo: matching info to use to find a possible context to share.

 *

drivers/infiniband/hw/hfi1/hfi.h

+1 −1
Original line number Diff line number Diff line
@@ -1760,7 +1760,7 @@ static inline void pause_for_credit_return(struct hfi1_devdata *dd) 
}



/**

 * sc_to_vlt() reverse lookup sc to vl

 * sc_to_vlt() - reverse lookup sc to vl

 * @dd - devdata

 * @sc5 - 5 bit sc

 */