diff mbox series

[rdma-next] RDMA: Fix kernel-doc warnings about wrong comment

Message ID 635def71048cbffe76e2dd324cf420d8a465ee9d.1622460676.git.leonro@nvidia.com (mailing list archive)
State Superseded
Headers show
Series [rdma-next] RDMA: Fix kernel-doc warnings about wrong comment | expand

Commit Message

Leon Romanovsky May 31, 2021, 12:03 p.m. UTC
From: Leon Romanovsky <leonro@nvidia.com>

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/

Signed-off-by: Leon Romanovsky <leonro@nvidia.com>
---
 * Straightforward change to make our CI happy.
---
 drivers/infiniband/core/iwpm_util.h       |  2 +-
 drivers/infiniband/core/roce_gid_mgmt.c   |  5 +++--
 drivers/infiniband/hw/hfi1/chip.c         |  4 ++--
 drivers/infiniband/hw/hfi1/file_ops.c     |  6 +++---
 drivers/infiniband/hw/hfi1/hfi.h          |  2 +-
 drivers/infiniband/hw/hfi1/init.c         |  4 ++--
 drivers/infiniband/hw/hfi1/pio.c          |  2 +-
 drivers/infiniband/hw/i40iw/i40iw.h       |  3 ---
 drivers/infiniband/hw/i40iw/i40iw_cm.c    | 10 +++++-----
 drivers/infiniband/hw/i40iw/i40iw_hmc.c   |  2 +-
 drivers/infiniband/hw/i40iw/i40iw_utils.c |  2 +-
 drivers/infiniband/sw/rdmavt/mr.c         |  4 ++--
 drivers/infiniband/sw/rdmavt/qp.c         |  3 ++-
 drivers/infiniband/sw/rdmavt/vt.c         |  4 ++--
 drivers/infiniband/ulp/ipoib/ipoib_main.c |  7 ++++---
 drivers/infiniband/ulp/iser/iser_verbs.c  |  2 +-
 drivers/infiniband/ulp/isert/ib_isert.c   |  4 ++--
 drivers/infiniband/ulp/rtrs/rtrs-clt.c    |  4 ++--
 drivers/infiniband/ulp/rtrs/rtrs-srv.c    |  2 +-
 19 files changed, 36 insertions(+), 36 deletions(-)

Comments

Jack Wang May 31, 2021, 12:31 p.m. UTC | #1
On Mon, May 31, 2021 at 2:03 PM Leon Romanovsky <leon@kernel.org> wrote:
>
> From: Leon Romanovsky <leonro@nvidia.com>
>
> 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/
>
> Signed-off-by: Leon Romanovsky <leonro@nvidia.com>
> ---
>  * Straightforward change to make our CI happy.
> ---
>  drivers/infiniband/core/iwpm_util.h       |  2 +-
>  drivers/infiniband/core/roce_gid_mgmt.c   |  5 +++--
>  drivers/infiniband/hw/hfi1/chip.c         |  4 ++--
>  drivers/infiniband/hw/hfi1/file_ops.c     |  6 +++---
>  drivers/infiniband/hw/hfi1/hfi.h          |  2 +-
>  drivers/infiniband/hw/hfi1/init.c         |  4 ++--
>  drivers/infiniband/hw/hfi1/pio.c          |  2 +-
>  drivers/infiniband/hw/i40iw/i40iw.h       |  3 ---
>  drivers/infiniband/hw/i40iw/i40iw_cm.c    | 10 +++++-----
>  drivers/infiniband/hw/i40iw/i40iw_hmc.c   |  2 +-
>  drivers/infiniband/hw/i40iw/i40iw_utils.c |  2 +-
>  drivers/infiniband/sw/rdmavt/mr.c         |  4 ++--
>  drivers/infiniband/sw/rdmavt/qp.c         |  3 ++-
>  drivers/infiniband/sw/rdmavt/vt.c         |  4 ++--
>  drivers/infiniband/ulp/ipoib/ipoib_main.c |  7 ++++---
>  drivers/infiniband/ulp/iser/iser_verbs.c  |  2 +-
>  drivers/infiniband/ulp/isert/ib_isert.c   |  4 ++--
>  drivers/infiniband/ulp/rtrs/rtrs-clt.c    |  4 ++--
>  drivers/infiniband/ulp/rtrs/rtrs-srv.c    |  2 +-
for rtrs, looks good to me, thx!
Reviewed-by: Jack Wang <jinpu.wang@ionos.com>
diff mbox series

Patch

diff --git a/drivers/infiniband/core/iwpm_util.h b/drivers/infiniband/core/iwpm_util.h
index eeb8e6010907..61380583d2a6 100644
--- a/drivers/infiniband/core/iwpm_util.h
+++ b/drivers/infiniband/core/iwpm_util.h
@@ -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
diff --git a/drivers/infiniband/core/roce_gid_mgmt.c b/drivers/infiniband/core/roce_gid_mgmt.c
index 7b638d91a4ec..68197e576433 100644
--- a/drivers/infiniband/core/roce_gid_mgmt.c
+++ b/drivers/infiniband/core/roce_gid_mgmt.c
@@ -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.
diff --git a/drivers/infiniband/hw/hfi1/chip.c b/drivers/infiniband/hw/hfi1/chip.c
index 5eeae8df415b..c97544638367 100644
--- a/drivers/infiniband/hw/hfi1/chip.c
+++ b/drivers/infiniband/hw/hfi1/chip.c
@@ -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
diff --git a/drivers/infiniband/hw/hfi1/file_ops.c b/drivers/infiniband/hw/hfi1/file_ops.c
index 3b7bbc7b9d10..955c3637980e 100644
--- a/drivers/infiniband/hw/hfi1/file_ops.c
+++ b/drivers/infiniband/hw/hfi1/file_ops.c
@@ -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.
  *
diff --git a/drivers/infiniband/hw/hfi1/hfi.h b/drivers/infiniband/hw/hfi1/hfi.h
index 867ae0b1aa95..9e020bb6f405 100644
--- a/drivers/infiniband/hw/hfi1/hfi.h
+++ b/drivers/infiniband/hw/hfi1/hfi.h
@@ -1764,7 +1764,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
  */
diff --git a/drivers/infiniband/hw/hfi1/init.c b/drivers/infiniband/hw/hfi1/init.c
index e3a8a420c045..0986aa065418 100644
--- a/drivers/infiniband/hw/hfi1/init.c
+++ b/drivers/infiniband/hw/hfi1/init.c
@@ -312,7 +312,7 @@  struct hfi1_ctxtdata *hfi1_rcd_get_by_index_safe(struct hfi1_devdata *dd,
 }
 
 /**
- * hfi1_rcd_get_by_index
+ * hfi1_rcd_get_by_index - get by index
  * @dd: pointer to a valid devdata structure
  * @ctxt: the index of an possilbe rcd
  *
@@ -499,7 +499,7 @@  int hfi1_create_ctxtdata(struct hfi1_pportdata *ppd, int numa,
 }
 
 /**
- * hfi1_free_ctxt
+ * hfi1_free_ctxt - free context
  * @rcd: pointer to an initialized rcd data structure
  *
  * This wrapper is the free function that matches hfi1_create_ctxtdata().
diff --git a/drivers/infiniband/hw/hfi1/pio.c b/drivers/infiniband/hw/hfi1/pio.c
index ff864f6f0266..e276522104c6 100644
--- a/drivers/infiniband/hw/hfi1/pio.c
+++ b/drivers/infiniband/hw/hfi1/pio.c
@@ -993,7 +993,7 @@  static bool is_sc_halted(struct hfi1_devdata *dd, u32 hw_context)
 }
 
 /**
- * sc_wait_for_packet_egress
+ * sc_wait_for_packet_egress - wait for packet
  * @sc: valid send context
  * @pause: wait for credit return
  *
diff --git a/drivers/infiniband/hw/i40iw/i40iw.h b/drivers/infiniband/hw/i40iw/i40iw.h
index be4094ac4fac..a27c3d1ad4f8 100644
--- a/drivers/infiniband/hw/i40iw/i40iw.h
+++ b/drivers/infiniband/hw/i40iw/i40iw.h
@@ -506,9 +506,6 @@  static inline void i40iw_free_resource(struct i40iw_device *iwdev,
 
 struct i40iw_handler *i40iw_find_netdev(struct net_device *netdev);
 
-/**
- * iw_init_resources -
- */
 u32 i40iw_initialize_hw_resources(struct i40iw_device *iwdev);
 
 int i40iw_register_rdma_device(struct i40iw_device *iwdev);
diff --git a/drivers/infiniband/hw/i40iw/i40iw_cm.c b/drivers/infiniband/hw/i40iw/i40iw_cm.c
index 2450b7dd51f6..d27d52b7c922 100644
--- a/drivers/infiniband/hw/i40iw/i40iw_cm.c
+++ b/drivers/infiniband/hw/i40iw/i40iw_cm.c
@@ -207,7 +207,7 @@  static inline void i40iw_fill_sockaddr6(struct i40iw_cm_node *cm_node,
 }
 
 /**
- * i40iw_get_addr_info
+ * i40iw_get_addr_info - get addr info
  * @cm_node: contains ip/tcp info
  * @cm_info: to get a copy of the cm_node ip/tcp info
 */
@@ -628,7 +628,7 @@  static void i40iw_event_connect_error(struct i40iw_cm_event *event)
 }
 
 /**
- * i40iw_process_options
+ * i40iw_process_options - process options
  * @cm_node: connection's node
  * @optionsloc: point to start of options
  * @optionsize: size of all options
@@ -687,7 +687,7 @@  static int i40iw_process_options(struct i40iw_cm_node *cm_node,
 }
 
 /**
- * i40iw_handle_tcp_options -
+ * i40iw_handle_tcp_options - handle TCP options
  * @cm_node: connection's node
  * @tcph: pointer tcp header
  * @optionsize: size of options rcvd
@@ -870,7 +870,7 @@  static int i40iw_send_mpa_request(struct i40iw_cm_node *cm_node)
 }
 
 /**
- * i40iw_send_mpa_reject -
+ * i40iw_send_mpa_reject - send MPA reject
  * @cm_node: connection's node
  * @pdata: reject data for connection
  * @plen: length of reject data
@@ -1040,7 +1040,7 @@  static int i40iw_parse_mpa(struct i40iw_cm_node *cm_node, u8 *buffer, u32 *type,
 }
 
 /**
- * i40iw_schedule_cm_timer
+ * i40iw_schedule_cm_timer - schedule CM timer
  * @cm_node: connection's node
  * @sqbuf: buffer to send
  * @type: if it is send or close
diff --git a/drivers/infiniband/hw/i40iw/i40iw_hmc.c b/drivers/infiniband/hw/i40iw/i40iw_hmc.c
index b44bfc1d239b..4cdd763ab6f9 100644
--- a/drivers/infiniband/hw/i40iw/i40iw_hmc.c
+++ b/drivers/infiniband/hw/i40iw/i40iw_hmc.c
@@ -781,7 +781,7 @@  enum i40iw_status_code i40iw_prep_remove_pd_page(struct i40iw_hmc_info *hmc_info
 }
 
 /**
- * i40iw_pf_init_vfhmc -
+ * i40iw_pf_init_vfhmc - init vfhmc
  * @vf_cnt_array: array of cnt values of iwarp hmc objects
  * @vf_hmc_fn_id: hmc function id ofr vf driver
  * @dev: pointer to i40iw_dev struct
diff --git a/drivers/infiniband/hw/i40iw/i40iw_utils.c b/drivers/infiniband/hw/i40iw/i40iw_utils.c
index 9ff825f7860b..a1efabc1ad0a 100644
--- a/drivers/infiniband/hw/i40iw/i40iw_utils.c
+++ b/drivers/infiniband/hw/i40iw/i40iw_utils.c
@@ -963,7 +963,7 @@  void i40iw_cqp_spawn_worker(struct i40iw_sc_dev *dev,
 }
 
 /**
- * i40iw_cqp_manage_hmc_fcn_worker -
+ * i40iw_cqp_manage_hmc_fcn_worker - manage hmc
  * @work: work pointer for hmc info
  */
 static void i40iw_cqp_manage_hmc_fcn_worker(struct work_struct *work)
diff --git a/drivers/infiniband/sw/rdmavt/mr.c b/drivers/infiniband/sw/rdmavt/mr.c
index 601d18dda1f5..34b7af6ab9c2 100644
--- a/drivers/infiniband/sw/rdmavt/mr.c
+++ b/drivers/infiniband/sw/rdmavt/mr.c
@@ -101,8 +101,8 @@  int rvt_driver_mr_init(struct rvt_dev_info *rdi)
 }
 
 /**
- *rvt_mr_exit: clean up MR
- *@rdi: rvt dev structure
+ * rvt_mr_exit - clean up MR
+ * @rdi: rvt dev structure
  *
  * called when drivers have unregistered or perhaps failed to register with us
  */
diff --git a/drivers/infiniband/sw/rdmavt/qp.c b/drivers/infiniband/sw/rdmavt/qp.c
index 4522071fc220..1111eee8d05a 100644
--- a/drivers/infiniband/sw/rdmavt/qp.c
+++ b/drivers/infiniband/sw/rdmavt/qp.c
@@ -984,7 +984,8 @@  static void rvt_reset_qp(struct rvt_dev_info *rdi, struct rvt_qp *qp,
 	spin_unlock_irq(&qp->r_lock);
 }
 
-/** rvt_free_qpn - Free a qpn from the bit map
+/**
+ * rvt_free_qpn - Free a qpn from the bit map
  * @qpt: QP table
  * @qpn: queue pair number to free
  */
diff --git a/drivers/infiniband/sw/rdmavt/vt.c b/drivers/infiniband/sw/rdmavt/vt.c
index 12ebe041a5da..3749380ff193 100644
--- a/drivers/infiniband/sw/rdmavt/vt.c
+++ b/drivers/infiniband/sw/rdmavt/vt.c
@@ -144,7 +144,7 @@  static int rvt_modify_device(struct ib_device *device,
 }
 
 /**
- * rvt_query_port: Passes the query port call to the driver
+ * rvt_query_port - Passes the query port call to the driver
  * @ibdev: Verbs IB dev
  * @port_num: port number, 1 based from ib core
  * @props: structure to hold returned properties
@@ -175,7 +175,7 @@  static int rvt_query_port(struct ib_device *ibdev, u32 port_num,
 }
 
 /**
- * rvt_modify_port
+ * rvt_modify_port - modify port
  * @ibdev: Verbs IB dev
  * @port_num: Port number, 1 based from ib core
  * @port_modify_mask: How to change the port
diff --git a/drivers/infiniband/ulp/ipoib/ipoib_main.c b/drivers/infiniband/ulp/ipoib/ipoib_main.c
index a4f9220161ad..b3dfa973b377 100644
--- a/drivers/infiniband/ulp/ipoib/ipoib_main.c
+++ b/drivers/infiniband/ulp/ipoib/ipoib_main.c
@@ -316,7 +316,7 @@  static bool ipoib_is_dev_match_addr_rcu(const struct sockaddr *addr,
 	return false;
 }
 
-/**
+/*
  * Find the master net_device on top of the given net_device.
  * @dev: base IPoIB net_device
  *
@@ -361,8 +361,9 @@  static int ipoib_upper_walk(struct net_device *upper,
 }
 
 /**
- * Find a net_device matching the given address, which is an upper device of
- * the given net_device.
+ * ipoib_get_net_dev_match_addr - Find a net_device matching
+ * the given address, which is an upper device of the given net_device.
+ *
  * @addr: IP address to look for.
  * @dev: base IPoIB net_device
  *
diff --git a/drivers/infiniband/ulp/iser/iser_verbs.c b/drivers/infiniband/ulp/iser/iser_verbs.c
index 136f6c4492e0..b44cbb8e84eb 100644
--- a/drivers/infiniband/ulp/iser/iser_verbs.c
+++ b/drivers/infiniband/ulp/iser/iser_verbs.c
@@ -761,7 +761,7 @@  void iser_conn_init(struct iser_conn *iser_conn)
 	ib_conn->reg_cqe.done = iser_reg_comp;
 }
 
- /**
+/*
  * starts the process of connecting to the target
  * sleeps until the connection is established or rejected
  */
diff --git a/drivers/infiniband/ulp/isert/ib_isert.c b/drivers/infiniband/ulp/isert/ib_isert.c
index 160efef66031..8634c83067da 100644
--- a/drivers/infiniband/ulp/isert/ib_isert.c
+++ b/drivers/infiniband/ulp/isert/ib_isert.c
@@ -2397,10 +2397,10 @@  isert_accept_np(struct iscsi_np *np, struct iscsi_conn *conn)
 		spin_unlock_bh(&np->np_thread_lock);
 		isert_dbg("np_thread_state %d\n",
 			 np->np_thread_state);
-		/**
+		/*
 		 * No point in stalling here when np_thread
 		 * is in state RESET/SHUTDOWN/EXIT - bail
-		 **/
+		 */
 		return -ENODEV;
 	}
 	spin_unlock_bh(&np->np_thread_lock);
diff --git a/drivers/infiniband/ulp/rtrs/rtrs-clt.c b/drivers/infiniband/ulp/rtrs/rtrs-clt.c
index 0a794d748a7a..62807321be89 100644
--- a/drivers/infiniband/ulp/rtrs/rtrs-clt.c
+++ b/drivers/infiniband/ulp/rtrs/rtrs-clt.c
@@ -913,7 +913,7 @@  static inline void path_it_deinit(struct path_it *it)
 }
 
 /**
- * rtrs_clt_init_req() Initialize an rtrs_clt_io_req holding information
+ * rtrs_clt_init_req() - Initialize an rtrs_clt_io_req holding information
  * about an inflight IO.
  * The user buffer holding user control message (not data) is copied into
  * the corresponding buffer of rtrs_iu (req->iu->buf), which later on will
@@ -1219,7 +1219,7 @@  static int rtrs_clt_read_req(struct rtrs_clt_io_req *req)
 }
 
 /**
- * rtrs_clt_failover_req() Try to find an active path for a failed request
+ * rtrs_clt_failover_req() - Try to find an active path for a failed request
  * @clt: clt context
  * @fail_req: a failed io request.
  */
diff --git a/drivers/infiniband/ulp/rtrs/rtrs-srv.c b/drivers/infiniband/ulp/rtrs/rtrs-srv.c
index 0fa116cabc44..8d1a19df30bf 100644
--- a/drivers/infiniband/ulp/rtrs/rtrs-srv.c
+++ b/drivers/infiniband/ulp/rtrs/rtrs-srv.c
@@ -1288,7 +1288,7 @@  int rtrs_srv_get_sess_name(struct rtrs_srv *srv, char *sessname, size_t len)
 EXPORT_SYMBOL(rtrs_srv_get_sess_name);
 
 /**
- * rtrs_srv_get_sess_qdepth() - Get rtrs_srv qdepth.
+ * rtrs_srv_get_queue_depth() - Get rtrs_srv qdepth.
  * @srv:	Session
  */
 int rtrs_srv_get_queue_depth(struct rtrs_srv *srv)