Skip to contentSkip to conversation

mips: netlogic: fix kernel-doc complaints in fmn-config.c

PATCH Applied Randy Dunlap 2 participants 2 messages Jul 20, 2021 – Jul 22, 2021 MIPS

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mips: netlogic: fix kernel-doc complaints in fmn-config.c

Clean up kernel-doc warnings in netlogic/xlr/fmn-config.c by using correct kernel-doc format. Fixes these warnings:

arch/mips/netlogic/xlr/fmn-config.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Configure bucket size and credits for a device. 'size' is the size of
arch/mips/netlogic/xlr/fmn-config.c:181: warning: expecting prototype for Setup the FMN details for each devices according to the device available(). Prototype was for xlr_board_info_setup() instead

Cc Ganesan Ramalingam <[email protected]>
Cc John Crispin <[email protected]>
Cc Aditya Srivastava <[email protected]>
Cc Thomas Bogendoerfer <[email protected]>
---
 arch/mips/netlogic/xlr/fmn-config.c |   15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)
arch/mips/netlogic/xlr/fmn-config.c +9 -6
@@ -103,18 +103,19 @@ static void check_credit_distribution(vo
 }
 
 /**
- * Configure bucket size and credits for a device. 'size' is the size of
- * the buckets for the device. This size is distributed among all the CPUs
- * so that all of them can send messages to the device.
- *
- * The device is also given 'cpu_credits' to send messages to the CPUs
- *
+ * setup_fmn_cc -  Configure bucket size and credits for a device.
  * @dev_info: FMN information structure for each devices
  * @start_stn_id: Starting station id of dev_info
  * @end_stn_id: End station id of dev_info
  * @num_buckets: Total number of buckets for den_info
  * @cpu_credits: Allowed credits to cpu for each devices pointing by dev_info
  * @size: Size of the each buckets in the device station
+ *
+ * 'size' is the size of the buckets for the device. This size is
+ * distributed among all the CPUs
+ * so that all of them can send messages to the device.
+ *
+ * The device is also given 'cpu_credits' to send messages to the CPUs
  */
 static void setup_fmn_cc(struct xlr_fmn_info *dev_info, int start_stn_id,
 		int end_stn_id, int num_buckets, int cpu_credits, int size)
@@ -174,6 +175,8 @@ static void setup_cpu_fmninfo(struct xlr
 }
 
 /**
+ * xlr_board_info_setup - Setup FMN details
+ *
  * Setup the FMN details for each devices according to the device available
  * in each variant of XLR/XLS processor
  */
maintainer Applied
#1 lore raw
Quoted 14 lines · Randy Dunlap

Clean up kernel-doc warnings in netlogic/xlr/fmn-config.c by using correct kernel-doc format. Fixes these warnings:

arch/mips/netlogic/xlr/fmn-config.c:106: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Configure bucket size and credits for a device. 'size' is the size of
arch/mips/netlogic/xlr/fmn-config.c:181: warning: expecting prototype for Setup the FMN details for each devices according to the device available(). Prototype was for xlr_board_info_setup() instead

Cc Ganesan Ramalingam <[email protected]>
Cc John Crispin <[email protected]>
Cc Aditya Srivastava <[email protected]>
Cc Thomas Bogendoerfer <[email protected]>
Quoted 3 lines
---
 arch/mips/netlogic/xlr/fmn-config.c |   15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

applied to mips-next.

Thomas.

Signature · 2 lines
Crap can work. Given enough thrust pigs will fly, but it's not necessarily a
good idea.                                                [ RFC1925, 2.3 ]