Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Dennis Dalessandro <dennis.dalessandro@cornelisnetworks.com>
Signed-off-by: Leon Romanovsky <leonro@nvidia.com>
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>

authored by

Leon Romanovsky and committed by
Jason Gunthorpe
bf194997 da43b7be

+31 -28
+1 -1
drivers/infiniband/core/iwpm_util.h
··· 183 183 void iwpm_set_registration(u8 nl_client, u32 reg); 184 184 185 185 /** 186 - * iwpm_get_registration 186 + * iwpm_get_registration - Get the client registration 187 187 * @nl_client: The index of the netlink client 188 188 * 189 189 * Returns the client registration type
+3 -2
drivers/infiniband/core/roce_gid_mgmt.c
··· 186 186 return res; 187 187 } 188 188 189 - /** is_ndev_for_default_gid_filter - Check if a given netdevice 189 + /** 190 + * is_ndev_for_default_gid_filter - Check if a given netdevice 190 191 * can be considered for default GIDs or not. 191 192 * @ib_dev: IB device to check 192 193 * @port: Port to consider for adding default GID 193 194 * @rdma_ndev: rdma netdevice pointer 194 - * @cookie_ndev: Netdevice to consider to form a default GID 195 + * @cookie: Netdevice to consider to form a default GID 195 196 * 196 197 * is_ndev_for_default_gid_filter() returns true if a given netdevice can be 197 198 * considered for deriving default RoCE GID, returns false otherwise.
+2 -2
drivers/infiniband/hw/hfi1/chip.c
··· 14186 14186 } 14187 14187 14188 14188 /** 14189 - * hfi1_get_qp_map 14189 + * hfi1_get_qp_map - get qp map 14190 14190 * @dd: device data 14191 14191 * @idx: index to read 14192 14192 */ ··· 14199 14199 } 14200 14200 14201 14201 /** 14202 - * init_qpmap_table 14202 + * init_qpmap_table - init qp map 14203 14203 * @dd: device data 14204 14204 * @first_ctxt: first context 14205 14205 * @last_ctxt: first context
+3 -3
drivers/infiniband/hw/hfi1/file_ops.c
··· 736 736 } 737 737 738 738 /** 739 - * complete_subctxt 739 + * complete_subctxt - complete sub-context info 740 740 * @fd: valid filedata pointer 741 741 * 742 742 * Sub-context info can only be set up after the base context ··· 841 841 } 842 842 843 843 /** 844 - * match_ctxt 844 + * match_ctxt - match context 845 845 * @fd: valid filedata pointer 846 846 * @uinfo: user info to compare base context with 847 847 * @uctxt: context to compare uinfo to. ··· 898 898 } 899 899 900 900 /** 901 - * find_sub_ctxt 901 + * find_sub_ctxt - fund sub-context 902 902 * @fd: valid filedata pointer 903 903 * @uinfo: matching info to use to find a possible context to share. 904 904 *
+1 -1
drivers/infiniband/hw/hfi1/hfi.h
··· 1760 1760 } 1761 1761 1762 1762 /** 1763 - * sc_to_vlt() reverse lookup sc to vl 1763 + * sc_to_vlt() - reverse lookup sc to vl 1764 1764 * @dd - devdata 1765 1765 * @sc5 - 5 bit sc 1766 1766 */
+2 -2
drivers/infiniband/hw/hfi1/init.c
··· 312 312 } 313 313 314 314 /** 315 - * hfi1_rcd_get_by_index 315 + * hfi1_rcd_get_by_index - get by index 316 316 * @dd: pointer to a valid devdata structure 317 317 * @ctxt: the index of an possilbe rcd 318 318 * ··· 499 499 } 500 500 501 501 /** 502 - * hfi1_free_ctxt 502 + * hfi1_free_ctxt - free context 503 503 * @rcd: pointer to an initialized rcd data structure 504 504 * 505 505 * This wrapper is the free function that matches hfi1_create_ctxtdata().
+1 -1
drivers/infiniband/hw/hfi1/pio.c
··· 993 993 } 994 994 995 995 /** 996 - * sc_wait_for_packet_egress 996 + * sc_wait_for_packet_egress - wait for packet 997 997 * @sc: valid send context 998 998 * @pause: wait for credit return 999 999 *
+2 -2
drivers/infiniband/hw/hns/hns_roce_hem.c
··· 1082 1082 return bt_level >= (hopnum ? hopnum - 1 : hopnum); 1083 1083 } 1084 1084 1085 - /** 1085 + /* 1086 1086 * calc base address entries num 1087 1087 * @hopnum: num of mutihop addressing 1088 1088 * @bt_level: base address table level ··· 1115 1115 return step; 1116 1116 } 1117 1117 1118 - /** 1118 + /* 1119 1119 * calc the root ba entries which could cover all regions 1120 1120 * @regions: buf region array 1121 1121 * @region_cnt: array size of @regions
+2 -2
drivers/infiniband/sw/rdmavt/mr.c
··· 101 101 } 102 102 103 103 /** 104 - *rvt_mr_exit: clean up MR 105 - *@rdi: rvt dev structure 104 + * rvt_mr_exit - clean up MR 105 + * @rdi: rvt dev structure 106 106 * 107 107 * called when drivers have unregistered or perhaps failed to register with us 108 108 */
+2 -1
drivers/infiniband/sw/rdmavt/qp.c
··· 984 984 spin_unlock_irq(&qp->r_lock); 985 985 } 986 986 987 - /** rvt_free_qpn - Free a qpn from the bit map 987 + /** 988 + * rvt_free_qpn - Free a qpn from the bit map 988 989 * @qpt: QP table 989 990 * @qpn: queue pair number to free 990 991 */
+2 -2
drivers/infiniband/sw/rdmavt/vt.c
··· 144 144 } 145 145 146 146 /** 147 - * rvt_query_port: Passes the query port call to the driver 147 + * rvt_query_port - Passes the query port call to the driver 148 148 * @ibdev: Verbs IB dev 149 149 * @port_num: port number, 1 based from ib core 150 150 * @props: structure to hold returned properties ··· 175 175 } 176 176 177 177 /** 178 - * rvt_modify_port 178 + * rvt_modify_port - modify port 179 179 * @ibdev: Verbs IB dev 180 180 * @port_num: Port number, 1 based from ib core 181 181 * @port_modify_mask: How to change the port
+4 -3
drivers/infiniband/ulp/ipoib/ipoib_main.c
··· 316 316 return false; 317 317 } 318 318 319 - /** 319 + /* 320 320 * Find the master net_device on top of the given net_device. 321 321 * @dev: base IPoIB net_device 322 322 * ··· 361 361 } 362 362 363 363 /** 364 - * Find a net_device matching the given address, which is an upper device of 365 - * the given net_device. 364 + * ipoib_get_net_dev_match_addr - Find a net_device matching 365 + * the given address, which is an upper device of the given net_device. 366 + * 366 367 * @addr: IP address to look for. 367 368 * @dev: base IPoIB net_device 368 369 *
+1 -1
drivers/infiniband/ulp/iser/iser_verbs.c
··· 761 761 ib_conn->reg_cqe.done = iser_reg_comp; 762 762 } 763 763 764 - /** 764 + /* 765 765 * starts the process of connecting to the target 766 766 * sleeps until the connection is established or rejected 767 767 */
+2 -2
drivers/infiniband/ulp/isert/ib_isert.c
··· 2397 2397 spin_unlock_bh(&np->np_thread_lock); 2398 2398 isert_dbg("np_thread_state %d\n", 2399 2399 np->np_thread_state); 2400 - /** 2400 + /* 2401 2401 * No point in stalling here when np_thread 2402 2402 * is in state RESET/SHUTDOWN/EXIT - bail 2403 - **/ 2403 + */ 2404 2404 return -ENODEV; 2405 2405 } 2406 2406 spin_unlock_bh(&np->np_thread_lock);
+2 -2
drivers/infiniband/ulp/rtrs/rtrs-clt.c
··· 915 915 } 916 916 917 917 /** 918 - * rtrs_clt_init_req() Initialize an rtrs_clt_io_req holding information 918 + * rtrs_clt_init_req() - Initialize an rtrs_clt_io_req holding information 919 919 * about an inflight IO. 920 920 * The user buffer holding user control message (not data) is copied into 921 921 * the corresponding buffer of rtrs_iu (req->iu->buf), which later on will ··· 1221 1221 } 1222 1222 1223 1223 /** 1224 - * rtrs_clt_failover_req() Try to find an active path for a failed request 1224 + * rtrs_clt_failover_req() - Try to find an active path for a failed request 1225 1225 * @clt: clt context 1226 1226 * @fail_req: a failed io request. 1227 1227 */
+1 -1
drivers/infiniband/ulp/rtrs/rtrs-srv.c
··· 1308 1308 EXPORT_SYMBOL(rtrs_srv_get_sess_name); 1309 1309 1310 1310 /** 1311 - * rtrs_srv_get_sess_qdepth() - Get rtrs_srv qdepth. 1311 + * rtrs_srv_get_queue_depth() - Get rtrs_srv qdepth. 1312 1312 * @srv: Session 1313 1313 */ 1314 1314 int rtrs_srv_get_queue_depth(struct rtrs_srv *srv)