Skip to contentSkip to conversation

RDMA/core: Fix kernel doc warnings

PATCH Applied Leon Romanovsky 2 participants 2 messages Feb 10, 2021 InfiniBand

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 RDMA/core: Fix kernel doc warnings

From: Leon Romanovsky <[email protected]>

drivers/infiniband/core/device.c:859: warning: Function parameter or member 'dev' not described in 'ib_port_immutable_read' drivers/infiniband/core/device.c:859: warning: Function parameter or member 'port' not described in 'ib_port_immutable_read'

Fixes 7416790e2245 ("RDMA/core: Introduce and use API to read port immutable data")
---
 drivers/infiniband/core/device.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
drivers/infiniband/core/device.c +3 -3
index 051c018fb73c..aac0fe14e1d9 100644
@@ -850,9 +850,9 @@ static int setup_port_data(struct ib_device *device)
 
 /**
  * ib_port_immutable_read() - Read rdma port's immutable data
- * @dev - IB device
- * @port - port number whose immutable data to read. It starts with index 1 and
- *         valid upto including rdma_end_port().
+ * @dev: IB device
+ * @port: port number whose immutable data to read. It starts with index 1 and
+ *        valid upto including rdma_end_port().
  */
 const struct ib_port_immutable*
 ib_port_immutable_read(struct ib_device *dev, unsigned int port)

--
2.29.2

maintainer Applied
#1 lore raw
Quoted 11 lines · Leon Romanovsky

From: Leon Romanovsky <[email protected]>

drivers/infiniband/core/device.c:859: warning: Function parameter or member 'dev' not described in 'ib_port_immutable_read' drivers/infiniband/core/device.c:859: warning: Function parameter or member 'port' not described in 'ib_port_immutable_read'

Fixes 7416790e2245 ("RDMA/core: Introduce and use API to read port immutable data")
---
 drivers/infiniband/core/device.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Applied to for-next thanks

Jason