]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
IB/cache: avoid kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Tue, 24 Feb 2026 00:31:06 +0000 (16:31 -0800)
committerLeon Romanovsky <leon@kernel.org>
Tue, 24 Feb 2026 10:38:45 +0000 (05:38 -0500)
Use the correct function parameters names to eliminate kernel-doc
warnings:

Warning: include/rdma/ib_cache.h:47 function parameter 'device_handle'
 not described in 'ib_get_cached_pkey'
Warning: include/rdma/ib_cache.h:89 function parameter 'port_active'
 not described in 'ib_get_cached_port_state'

(not adding missing function return value descriptions)

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260224003106.3172916-1-rdunlap@infradead.org
Signed-off-by: Leon Romanovsky <leon@kernel.org>
include/rdma/ib_cache.h

index 2bf09b594d10f85bccf26303af0a2ce096390c3c..eed46d966e40af5aa620228b63c061a28975eaaf 100644 (file)
@@ -34,7 +34,7 @@ struct net_device *rdma_read_gid_attr_ndev_rcu(const struct ib_gid_attr *attr);
 
 /**
  * ib_get_cached_pkey - Returns a cached PKey table entry
- * @device: The device to query.
+ * @device_handle: The device to query.
  * @port_num: The port number of the device to query.
  * @index: The index into the cached PKey table to query.
  * @pkey: The PKey value found at the specified index.
@@ -80,7 +80,7 @@ int ib_get_cached_lmc(struct ib_device *device,
  * ib_get_cached_port_state - Returns a cached port state table entry
  * @device: The device to query.
  * @port_num: The port number of the device to query.
- * @port_state: port_state for the specified port for that device.
+ * @port_active: port_state for the specified port for that device.
  *
  * ib_get_cached_port_state() fetches the specified port_state table entry stored in
  * the local software cache.