Commit 3c976761 authored by Lee Jones's avatar Lee Jones Committed by Jason Gunthorpe
Browse files

RDMA/core/cache: Fix some misspellings, missing and superfluous param descriptions 

Fixes the following W=1 kernel build warning(s):

 drivers/infiniband/core/cache.c:688: warning: Function parameter or member 'ib_dev' not described in 'rdma_find_gid_by_port'
 drivers/infiniband/core/cache.c:688: warning: Function parameter or member 'port' not described in 'rdma_find_gid_by_port'
 drivers/infiniband/core/cache.c:688: warning: Excess function parameter 'device' description in 'rdma_find_gid_by_port'
 drivers/infiniband/core/cache.c:688: warning: Excess function parameter 'port_num' description in 'rdma_find_gid_by_port'
 drivers/infiniband/core/cache.c:741: warning: Function parameter or member 'ib_dev' not described in 'rdma_find_gid_by_filter'
 drivers/infiniband/core/cache.c:741: warning: Function parameter or member 'context' not described in 'rdma_find_gid_by_filter'
 drivers/infiniband/core/cache.c:741: warning: Excess function parameter 'device' description in 'rdma_find_gid_by_filter'
 drivers/infiniband/core/cache.c:1263: warning: Excess function parameter 'num_entries' description in 'rdma_query_gid_table'

Link: https://lore.kernel.org/r/20210118223929.512175-6-lee.jones@linaro.org


Cc: Doug Ledford <dledford@redhat.com>
Cc: Jason Gunthorpe <jgg@ziepe.ca>
Cc: linux-rdma@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarJason Gunthorpe <jgg@nvidia.com>
parent 03e2dbbb

drivers/infiniband/core/cache.c

+4 −5
Original line number Diff line number Diff line
@@ -669,11 +669,10 @@ int ib_cache_gid_del_all_netdev_gids(struct ib_device *ib_dev, u8 port, 
 * rdma_find_gid_by_port - Returns the GID entry attributes when it finds

 * a valid GID entry for given search parameters. It searches for the specified

 * GID value in the local software cache.

 * @device: The device to query.

 * @ib_dev: The device to query.

 * @gid: The GID value to search for.

 * @gid_type: The GID type to search for.

 * @port_num: The port number of the device where the GID value should be

 *   searched.

 * @port: The port number of the device where the GID value should be searched.

 * @ndev: In RoCE, the net device of the device. NULL means ignore.

 *

 * Returns sgid attributes if the GID is found with valid reference or
@@ -719,7 +718,7 @@ EXPORT_SYMBOL(rdma_find_gid_by_port); 
/**

 * rdma_find_gid_by_filter - Returns the GID table attribute where a

 * specified GID value occurs

 * @device: The device to query.

 * @ib_dev: The device to query.

 * @gid: The GID value to search for.

 * @port: The port number of the device where the GID value could be

 *   searched.
@@ -728,6 +727,7 @@ EXPORT_SYMBOL(rdma_find_gid_by_port); 
 *   otherwise, we continue searching the GID table. It's guaranteed that

 *   while filter is executed, ndev field is valid and the structure won't

 *   change. filter is executed in an atomic context. filter must not be NULL.

 * @context: Private data to pass into the call-back.

 *

 * rdma_find_gid_by_filter() searches for the specified GID value

 * of which the filter function returns true in the port's GID table.
@@ -1253,7 +1253,6 @@ EXPORT_SYMBOL(rdma_get_gid_attr); 
 * @entries: Entries where GID entries are returned.

 * @max_entries: Maximum number of entries that can be returned.

 * Entries array must be allocated to hold max_entries number of entries.

 * @num_entries: Updated to the number of entries that were successfully read.

 *

 * Returns number of entries on success or appropriate error code.

 */