Commit d6537c1a authored by rd.dunlab@gmail.com's avatar rd.dunlab@gmail.com Committed by Jason Gunthorpe
Browse files

infiniband: fix core/ kernel-doc notation 

Correct function parameter names (typos or renames).
Add kernel-doc notation for missing function parameters.

../drivers/infiniband/core/sa_query.c:1263: warning: Function parameter or member 'gid_attr' not described in 'ib_init_ah_attr_from_path'
../drivers/infiniband/core/sa_query.c:1263: warning: Excess function parameter 'sgid_attr' description in 'ib_init_ah_attr_from_path'

../drivers/infiniband/core/device.c:145: warning: Function parameter or member 'dev' not described in 'rdma_dev_access_netns'
../drivers/infiniband/core/device.c:145: warning: Excess function parameter 'device' description in 'rdma_dev_access_netns'
../drivers/infiniband/core/device.c:1333: warning: Function parameter or member 'name' not described in 'ib_register_device'
../drivers/infiniband/core/device.c:1461: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device'
../drivers/infiniband/core/device.c:1461: warning: Excess function parameter 'device' description in 'ib_unregister_device'
../drivers/infiniband/core/device.c:1483: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device_and_put'
../drivers/infiniband/core/device.c:1550: warning: Function parameter or member 'ib_dev' not described in 'ib_unregister_device_queued'

Link: https://lore.kernel.org/r/20191010035240.191542461@gmail.com


Signed-off-by: default avatarRandy Dunlap <rd.dunlab@gmail.com>
Reviewed-by: default avatarJason Gunthorpe <jgg@mellanox.com>
Signed-off-by: default avatarJason Gunthorpe <jgg@mellanox.com>
parent b24da1a0

drivers/infiniband/core/device.c

+11 −12
Original line number Diff line number Diff line
@@ -128,17 +128,14 @@ module_param_named(netns_mode, ib_devices_shared_netns, bool, 0444); 
MODULE_PARM_DESC(netns_mode,

		 "Share device among net namespaces; default=1 (shared)");

/**

 * rdma_dev_access_netns() - Return whether a rdma device can be accessed

 * rdma_dev_access_netns() - Return whether an rdma device can be accessed

 *			     from a specified net namespace or not.

 * @device:	Pointer to rdma device which needs to be checked

 * @dev:	Pointer to rdma device which needs to be checked

 * @net:	Pointer to net namesapce for which access to be checked

 *

 * rdma_dev_access_netns() - Return whether a rdma device can be accessed

 *			     from a specified net namespace or not. When

 *			     rdma device is in shared mode, it ignores the

 *			     net namespace. When rdma device is exclusive

 *			     to a net namespace, rdma device net namespace is

 *			     checked against the specified one.

 * When the rdma device is in shared mode, it ignores the net namespace.

 * When the rdma device is exclusive to a net namespace, rdma device net

 * namespace is checked against the specified one.

 */

bool rdma_dev_access_netns(const struct ib_device *dev, const struct net *net)

{
@@ -1318,6 +1315,8 @@ static int enable_device_and_get(struct ib_device *device) 
/**

 * ib_register_device - Register an IB device with IB core

 * @device: Device to register

 * @name: unique string device name. This may include a '%' which will

 * cause a unique index to be added to the passed device name.

 *

 * Low-level drivers use ib_register_device() to register their

 * devices with the IB core.  All registered clients will receive a
@@ -1444,7 +1443,7 @@ static void __ib_unregister_device(struct ib_device *ib_dev) 


/**

 * ib_unregister_device - Unregister an IB device

 * @device: The device to unregister

 * @ib_dev: The device to unregister

 *

 * Unregister an IB device.  All clients will receive a remove callback.

 *
@@ -1466,7 +1465,7 @@ EXPORT_SYMBOL(ib_unregister_device); 


/**

 * ib_unregister_device_and_put - Unregister a device while holding a 'get'

 * device: The device to unregister

 * @ib_dev: The device to unregister

 *

 * This is the same as ib_unregister_device(), except it includes an internal

 * ib_device_put() that should match a 'get' obtained by the caller.
@@ -1536,7 +1535,7 @@ static void ib_unregister_work(struct work_struct *work) 


/**

 * ib_unregister_device_queued - Unregister a device using a work queue

 * device: The device to unregister

 * @ib_dev: The device to unregister

 *

 * This schedules an asynchronous unregistration using a WQ for the device. A

 * driver should use this to avoid holding locks while doing unregistration,

drivers/infiniband/core/sa_query.c

+1 −1
Original line number Diff line number Diff line
@@ -1246,7 +1246,7 @@ static int init_ah_attr_grh_fields(struct ib_device *device, u8 port_num, 
 * @port_num: Port on the specified device.

 * @rec: path record entry to use for ah attributes initialization.

 * @ah_attr: address handle attributes to initialization from path record.

 * @sgid_attr: SGID attribute to consider during initialization.

 * @gid_attr: SGID attribute to consider during initialization.

 *

 * When ib_init_ah_attr_from_path() returns success,

 * (a) for IB link layer it optionally contains a reference to SGID attribute