]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
NTB: fix kernel-doc warnings in ntb.h
authorRandy Dunlap <rdunlap@infradead.org>
Thu, 12 Mar 2026 05:14:15 +0000 (22:14 -0700)
committerJon Mason <jdmason@kudzu.us>
Sat, 27 Jun 2026 02:18:34 +0000 (22:18 -0400)
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@infradead.org>
Acked-by: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Jon Mason <jdmason@kudzu.us>
include/linux/ntb.h

index 879c3e89e026ffe8d1cf65f6892552b4905379b8..ae72caa0385972bbc95bb073e783b57f7b4ac4af 100644 (file)
@@ -567,7 +567,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.
@@ -582,7 +582,7 @@ int ntb_default_peer_port_count(struct ntb_dev *ntb);
 /**
  * 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.