[PATCH] NTB: fix kernel-doc warnings in ntb.h
From: Randy Dunlap
Date: Thu Mar 12 2026 - 01:15:34 EST
Correct a function name and function parameter name to avoid
kernel-doc warnings:
Warning: include/linux/ntb.h:575 expecting prototype for
ntb_default_port_count(). Prototype was for ntb_default_peer_port_count()
instead
Warning: include/linux/ntb.h:590 function parameter 'pidx' not
described in 'ntb_default_peer_port_number'
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
Cc: Jon Mason <jdmason@xxxxxxxx>
Cc: Dave Jiang <dave.jiang@xxxxxxxxx>
Cc: Allen Hubbe <allenbh@xxxxxxxxx>
Cc: ntb@xxxxxxxxxxxxxxx
include/linux/ntb.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- linux-next-20260311.orig/include/linux/ntb.h
+++ linux-next-20260311/include/linux/ntb.h
@@ -563,7 +563,7 @@ void ntb_msg_event(struct ntb_dev *ntb);
int ntb_default_port_number(struct ntb_dev *ntb);
/**
- * ntb_default_port_count() - get the default number of peer device ports
+ * ntb_default_peer_port_count() - get the default number of peer device ports
* @ntb: NTB device context.
*
* By default hardware driver supports just one peer device.
@@ -578,7 +578,7 @@ int ntb_default_peer_port_count(struct n
/**
* ntb_default_peer_port_number() - get the default peer port by given index
* @ntb: NTB device context.
- * @idx: Peer port index (should not differ from zero).
+ * @pidx: Peer port index (should not differ from zero).
*
* By default hardware driver supports just one peer device, so this method
* shall return the corresponding value from enum ntb_default_port.